cdklabs / cdklabs/cdk-contribution-skill
Discussion: how should this skill work with aws-cdk's AGENTS.md?
- Dominant language
- No language data
- Stars
- 110
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
### Context
[aws/aws-cdk#37565](https://github.com/aws/aws-cdk/pull/37565) added [`AGENTS.md`](https://github.com/aws/aws-cdk/blob/main/AGENTS.md) at the root of the aws-cdk repo. It is loaded automatically by AI agents working in the aws-cdk checkout and acts as the canonical contributor guide.
It seems worth thinking about how this skill should account for `AGENTS.md` going forward, so that the two remain complementary rather than diverge.
### One idea (not a proposal)
One direction would be to have each SOP whose subagent runs inside the aws-cdk checkout include a short instruction to read and follow aws-cdk's `AGENTS.md` before doing its work — since the substantive rules already live there.
But it's not clear this is the right shape. For example, the SOPs carry entry-level templates and JSII gotchas that don't fully overlap with `AGENTS.md`, so a blanket "defer to AGENTS.md" may lose useful content. There are probably other options (partial linking, side-by-side, etc.).
Opening this as a discussion rather than a concrete proposal — would love input on the right direction before anyone picks up a PR.
Contributor guide
Assessment
This issue has not been assessed yet.