|
| 1 | +# AGENTS.md |
| 2 | + |
| 3 | +## Project overview |
| 4 | + |
| 5 | +AI-DLC (AI-Driven Development Life Cycle) is a methodology for guiding AI coding |
| 6 | +agents through structured software development workflows. This repository contains |
| 7 | +the core workflow rules, detailed phase-specific rules, and an evaluator framework. |
| 8 | + |
| 9 | +## Repository structure |
| 10 | + |
| 11 | +```text |
| 12 | +aidlc-rules/ |
| 13 | +├── aws-aidlc-rules/ # Core workflow entry point (DO NOT rename) |
| 14 | +│ └── core-workflow.md |
| 15 | +└── aws-aidlc-rule-details/ # Detailed rules referenced by the workflow (DO NOT rename) |
| 16 | + ├── common/ # Shared guidance across all phases |
| 17 | + ├── inception/ # Planning and architecture rules |
| 18 | + ├── construction/ # Design and implementation rules |
| 19 | + ├── extensions/ # Optional cross-cutting constraint rules |
| 20 | + └── operations/ # Deployment and monitoring rules |
| 21 | +scripts/aidlc-evaluator/ # Python evaluation framework (uv-managed) |
| 22 | +.github/workflows/ # CI/CD pipelines |
| 23 | +docs/ # Project documentation and guides |
| 24 | +``` |
| 25 | + |
| 26 | +## Setup commands |
| 27 | + |
| 28 | +```bash |
| 29 | +# Lint all markdown files |
| 30 | +npx markdownlint-cli2 "**/*.md" |
| 31 | + |
| 32 | +# Fix markdown lint issues automatically |
| 33 | +npx markdownlint-cli2 --fix "**/*.md" |
| 34 | + |
| 35 | +# Run evaluator tests (from scripts/aidlc-evaluator/) |
| 36 | +cd scripts/aidlc-evaluator && uv run pytest |
| 37 | +``` |
| 38 | + |
| 39 | +## Code style |
| 40 | + |
| 41 | +- All content is Markdown — follow the `.markdownlint-cli2.yaml` configuration |
| 42 | +- MD013 (line length) is disabled — long URLs, tables, and code examples are acceptable |
| 43 | +- MD033 (inline HTML) is disabled — `<img>` tags are used for screenshots |
| 44 | +- MD060 (table alignment) is enforced — table pipes must be vertically aligned |
| 45 | +- MD040 (fenced code language) is enforced — always specify a language on code fences |
| 46 | +- Commit messages follow [conventional commits](https://www.conventionalcommits.org/) |
| 47 | + (e.g., `feat:`, `fix:`, `docs:`, `chore:`) |
| 48 | + |
| 49 | +## Testing instructions |
| 50 | + |
| 51 | +- Test rule changes with at least one supported platform (Amazon Q Developer, Kiro, |
| 52 | + Cursor, Cline, Claude Code, or GitHub Copilot) before submitting |
| 53 | +- If adding or updating installation instructions, test on macOS, Windows CMD, and |
| 54 | + Windows PowerShell |
| 55 | +- Run `npx markdownlint-cli2 "**/*.md"` before committing to catch lint issues |
| 56 | +- The pre-commit hook runs markdownlint automatically if configured |
| 57 | + |
| 58 | +## PR instructions |
| 59 | + |
| 60 | +- PR titles must follow conventional commits format (e.g., `fix: description`) |
| 61 | +- Always include this contributor statement at the end of the PR body: |
| 62 | + |
| 63 | + > By submitting this pull request, I confirm that you can use, modify, copy, |
| 64 | + > and redistribute this contribution, under the terms of the |
| 65 | + > [project license](https://github.com/awslabs/aidlc-workflows/blob/main/LICENSE). |
| 66 | +
|
| 67 | +- CI enforces: conventional commit title, contributor statement, markdownlint, and |
| 68 | + a do-not-merge label check |
| 69 | +- Use the structure from `.github/pull_request_template.md` |
| 70 | + |
| 71 | +## Important constraints |
| 72 | + |
| 73 | +- The folder names `aws-aidlc-rules/` and `aws-aidlc-rule-details/` are part of the |
| 74 | + public contract — do not rename, move, or reorganize them |
| 75 | +- Do not duplicate content across rules — place shared guidance in `common/` and |
| 76 | + reference it |
| 77 | +- Keep the core methodology IDE/agent/model agnostic |
| 78 | +- Security issues must be reported via |
| 79 | + [AWS vulnerability reporting](http://aws.amazon.com/security/vulnerability-reporting/), |
| 80 | + not public GitHub issues |
0 commit comments