Skip to content

feat: reference aws-cdk AGENTS.md as mandatory prerequisite in all SOPs#13

Open
chaodu-agent wants to merge 2 commits into
cdklabs:mainfrom
chaodu-agent:feat/reference-agents-md
Open

feat: reference aws-cdk AGENTS.md as mandatory prerequisite in all SOPs#13
chaodu-agent wants to merge 2 commits into
cdklabs:mainfrom
chaodu-agent:feat/reference-agents-md

Conversation

@chaodu-agent
Copy link
Copy Markdown

@chaodu-agent chaodu-agent commented May 18, 2026

Summary

Implements the layered integration strategy from #4: SOPs reference AGENTS.md as the canonical source for coding standards, eliminating duplication.

Principle

  • AGENTS.md = "what is good" (construct design, naming, props, security, testing standards)
  • Skill SOPs = "how to execute" (phase gates, deliverables, orchestration, exit criteria)

Changes

SKILL.md

  • Added Global Prerequisite declaration pointing to AGENTS.md

All 9 SOPs (build-engineer, documentation-specialist, implementation-specialist, quality-assurance, regression-reviewer, review-report-generator, security-reviewer, solution-architect, test-engineer)

  • Added ## Prerequisites section with single-line AGENTS.md reference
  • Preserved all ## Input Requirements and phase-specific workflow content

Removed duplicate content

  • implementation-specialist: JSII compatibility, error handling, validation, API design patterns, CloudFormation generation code blocks → replaced with AGENTS.md § Implementation Patterns pointer
  • security-reviewer: "REQUIRED Best Practices" list, "Common CDK Security Patterns" code blocks (IAM, S3, input validation) → replaced with AGENTS.md § Security Rules pointer
  • solution-architect: Feature Flag design details and code block → replaced with AGENTS.md § Feature Flags pointer
  • build-engineer: git upstream sync commands → replaced with AGENTS.md § Quick Reference — Commands pointer
  • test-engineer: yarn watch/test commands → replaced with AGENTS.md § Quick Reference — Commands pointer
  • quality-assurance: yarn build command → replaced with AGENTS.md § Quick Reference — Commands pointer

Closes #4

Thread: 1505913246815617024

chaodu-agent

This comment was marked as outdated.

@chaodu-agent chaodu-agent force-pushed the feat/reference-agents-md branch 2 times, most recently from 190a850 to cb6d7cd Compare May 18, 2026 15:19
chaodu-agent

This comment was marked as outdated.

@chaodu-agent chaodu-agent marked this pull request as ready for review May 18, 2026 15:20
- Add Prerequisites section to each SOP referencing AGENTS.md
- Remove duplicated code patterns (JSII, error handling, API design, CloudFormation)
- Remove duplicated security patterns (IAM, encryption, input validation)
- Remove duplicated Feature Flag implementation details
- Replace duplicated commands with AGENTS.md § Quick Reference pointers
- Keep SOP-specific: phase gates, deliverables, orchestration, output templates

Closes cdklabs#4
@chaodu-agent chaodu-agent force-pushed the feat/reference-agents-md branch from cb6d7cd to 26d80b9 Compare May 18, 2026 15:20
- build-engineer-sop: restore Step 2 git upstream sync commands (not a
  coding standard, it's skill-specific workflow)
- test-engineer-sop: restore Step 1/Step 2 separation with proper
  context for each step, reference AGENTS.md for exact commands only
- implementation-specialist-sop: rename heading to 'CDK Standards
  Reference' to clarify it's a pointer, not maintained content
Copy link
Copy Markdown

@gudipati gudipati left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From what I understand, Kiro / other agents already pick up the AGENTS.md file and use it with the skill right now so explicit instructions to read AGENTS.md is probably not required.

For removing the commands and referencing AGENTS.md § Quick Reference — Commands, were you able to test this on some issues to see that there is no regression in the behaviour of the skill ?

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.

Discussion: how should this skill work with aws-cdk's AGENTS.md?

2 participants