Skip to content

docs(agents): clarify subpackage layout for flat groups#857

Open
natalie-o-perret wants to merge 1 commit into
masterfrom
docs/agents-md-subpackage-layout
Open

docs(agents): clarify subpackage layout for flat groups#857
natalie-o-perret wants to merge 1 commit into
masterfrom
docs/agents-md-subpackage-layout

Conversation

@natalie-o-perret

@natalie-o-perret natalie-o-perret commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Description

Follow-up to #856. PR #855 refactored storage_bucket_lifecycle* in place; review asked to move them into a subpackage per cmd/aiservices/deployment/. AGENTS.md missed the placement cue: 3 tweaks so a future agent picks this up automatically:

  • Folder layout: anti-pattern callout naming the legacy flat groups (cmd/storage, cmd/dns, cmd/dbaas), cmd/aiservices/deployment/ as the canonical subpackage, and storage_bucket_lifecycle* as a worked example. Wording imperative (MUST promote).
  • Command pattern: cross-ref to Folder layout so an agent starting from the struct pattern doesn't skip placement.
  • File header rule: parametrize the model name (<model>) instead of pinning to claude-sonnet-4.6.

Checklist

(For exoscale contributors)

  • Changelog updated (under Unreleased block, and add the Pull Request #number for each bit you add to the CHANGELOG.md)
  • Testing

Testing

Docs-only.


Note

AI assistance: PR description.

@natalie-o-perret natalie-o-perret force-pushed the docs/agents-md-subpackage-layout branch from af9db0f to f08622f Compare July 2, 2026 08:08
PR #855 refactored storage_bucket_lifecycle* in place, keeping the
flat layout in cmd/storage/. Review feedback asked for them to be moved
into a subpackage along the lines of cmd/aiservices/deployment/.

Three small tweaks so a future agent picks this up automatically:

- Folder layout: add an anti-pattern callout naming the legacy flat
  groups (cmd/storage, cmd/dns, cmd/dbaas), the cmd/aiservices/deployment
  subpackage as the canonical pattern, and the storage_bucket_lifecycle
  case as a worked example. Wording is imperative ("MUST promote").
- Command pattern: cross-ref to Folder layout so an agent starting
  from the struct pattern doesn't miss the placement cue.
- File header rule: parametrize the model name (<model>) instead of
  hard-coding claude-sonnet-4.6.
@natalie-o-perret natalie-o-perret force-pushed the docs/agents-md-subpackage-layout branch from f08622f to 7a3c393 Compare July 2, 2026 09:13
@natalie-o-perret natalie-o-perret requested a review from a team July 2, 2026 09:29
@natalie-o-perret natalie-o-perret marked this pull request as ready for review July 2, 2026 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants