Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (41 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

67 lines (41 loc) · 2.66 KB

Contributing Guidelines

Thank you for your interest in contributing to AI-DLC. Whether it's a bug report, new rule, correction, or documentation improvement, we value feedback and contributions from the community.

Please read through this document before submitting any issues or pull requests.

Tenets

Before contributing, familiarize yourself with our tenets.

Contributing Rules

AI-DLC rules live in aidlc-rules/aws-aidlc-rule-details/. When contributing:

  • Be reproducible: Changes should be consistently reproducible either via test case or a series of step
  • Single source of truth: Don't duplicate content. If guidance applies to multiple stages, put it in common/ and reference it.
  • Keep it agnostic: The core methodology shouldn't assume specific IDEs, agents, or models. Tool-specific files are generated from the source.

Rule Structure

Rules are organized by phase:

  • common/ - Shared guidance across all phases
  • inception/ - Planning and architecture rules
  • construction/ - Design and implementation rules
  • operations/ - Deployment and monitoring rules

Testing Changes

Test your rule changes with at least one supported platform (Amazon Q Developer, Kiro, or other tools) before submitting. Describe what you tested in your PR.

Reporting Bugs/Feature Requests

Use GitHub issues to report bugs or suggest features. Before filing, check existing issues to avoid duplicates.

Include:

  • Which rule or stage is affected
  • Expected vs actual behavior
  • The platform/model you tested with

Contributing via Pull Requests

Before sending a pull request:

  1. Work against the latest main branch
  2. Check existing open and recently merged PRs
  3. Open an issue first for significant changes

To submit:

  1. Fork the repository
  2. Make your changes (keep them focused)
  3. Use clear commit messages following conventional commits (e.g., feat:, fix:, docs:)
  4. Submit the PR and respond to feedback

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct.

For more information see the Code of Conduct FAQ or contact opensource-codeofconduct@amazon.com with any additional questions or comments.

Security Issue Notifications

If you discover a potential security issue, notify AWS/Amazon Security via the vulnerability reporting page. Please do not create a public GitHub issue.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.