Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
113 lines (72 loc) · 5.92 KB

CONTRIBUTING.md

File metadata and controls

113 lines (72 loc) · 5.92 KB

Contributing Guidelines

Thank you for your interest in contributing. Whether it's a bug report, new feature, or documentation improvement, we value contributions from the community.

Reporting bugs and requesting features

Use the GitHub issue tracker to report bugs or suggest features. Before filing, check existing open and recently closed issues. For bug reports, include reproduction steps, expected vs actual behavior, and your environment details.

Contributing code

1. Open an issue first

Describe what you intend to contribute. This avoids duplicate work and gives maintainers a chance to provide early feedback on approach.

2. Set up your environment

Follow the Quick Start to clone, install, and build the project. See the Developer guide for local testing and the development workflow.

Use AGENTS.md to understand where to make changes (CDK vs CLI vs agent vs docs), which tests to extend, and common pitfalls (generated docs, mirrored API types, mise tasks).

3. Implement your change

Guidelines:

  • One logical change per pull request. Related changes (e.g. a feature + its tests) are fine together; unrelated changes should be separate PRs.
  • Every change requires a unit test. Tests live alongside the code they cover (cdk/test/ mirrors cdk/src/, agent/tests/, cli/test/).
  • Follow the code style around you. Linters run automatically on every PR (ESLint for TypeScript, Ruff for Python).
  • If you change API types in cdk/src/handlers/shared/types.ts, update cli/src/types.ts to match.
  • If you change docs sources (docs/guides/, docs/design/), run mise //docs:sync so generated content stays in sync.
  • For significant features, add a design document to docs/design/.

4. Commit

Commit messages must follow Conventional Commits:

feat(orchestrator): add retry logic for transient GitHub API failures

The orchestrator now retries GitHub API calls up to 3 times with
exponential backoff when it receives 5xx responses during pre-flight.

Closes #123

Rules:

  • Title format: feat(module):, fix(module):, or chore(module): - lowercase, no period at the end.
  • Body: describe the motivation (why, not what). Reference issues with Fixes #xxx or Closes #xxx.
  • Breaking changes: add BREAKING CHANGE: description at the end of the body.

5. Pull request

  • Push to a fork and open a PR against main.
  • The PR title and description become the squash commit message, so keep them accurate throughout the review.
  • The CI workflow runs mise run install then mise run build (compile + lint + test + synth + security scans for all packages).
  • Iterate on review feedback by pushing new commits to the same branch. Maintainers squash-merge when approved.

PR checklist

  • Unit test added
  • Integration test added (if introducing new CloudFormation resource types or cross-service configuration)
  • Documentation updated (README, guides, or design docs as appropriate)
  • Title follows conventional commits (feat(module):, fix(module):, chore(module):)
  • Breaking changes documented in commit body

Tooling

This repository uses mise for tool versions and monorepo tasks. The root mise.toml defines config roots for cdk, agent, cli, and docs.

Common commands:

Command What it does
mise run install Install all dependencies (Yarn workspaces + Python)
mise run build Full build: agent quality, CDK compile/lint/test/synth, CLI build, docs build
mise //cdk:build CDK only: compile + lint + test + synth
mise //agent:quality Agent only: lint + type check + tests
mise //cli:build CLI only: compile + test + lint
mise //docs:build Docs only: sync sources + Astro build
mise run hooks:run Run pre-commit and pre-push checks locally

Set export MISE_EXPERIMENTAL=1 for namespaced tasks like mise //cdk:build.

Git hooks

mise run install automatically installs prek git hooks. These run on every commit and push:

  • pre-commit - Whitespace/EOF checks, gitleaks on staged changes, linters (ESLint, Ruff, astro check) for touched files.
  • pre-push - Security scans (mise run hooks:pre-push:security) and tests across all packages (mise run hooks:pre-push:tests).

If prek install fails with "refusing to install hooks with core.hooksPath set", another tool owns your hooks. Either unset it (git config --unset-all core.hooksPath) or integrate these checks into your hook manager.

Versioning

The project uses semantic versioning based on Conventional Commits:

  • fix: bumps PATCH (v0.0.1)
  • feat: bumps MINOR (v0.1.0)
  • MAJOR bumps are done explicitly to protect consumers from breaking changes.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For questions, contact opensource-codeofconduct@amazon.com.

Security issue notifications

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

Licensing

See the LICENSE file. We will ask you to confirm the licensing of your contribution and may request a Contributor License Agreement (CLA) for larger changes.

© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.