Repository navigation
docs: write down the project premises, add AGENTS.md and the AI-assisted contribution policy - #8717
Merged
Merged
Conversation
…AI-assisted contribution policy Seven one-page ADRs under docs/adr for the premises we keep explaining in reviews, an AGENTS.md at the root pointing to commands, PR rules and the things we do not do, and a disclaimer in README, CONTRIBUTING and the PR and bug report templates: AI-assisted contributions are welcome when declared and verified by the author. ADRs stay out of the published site.
leandrodamascena
added
documentation
powertools-for-aws-oss-automation
Bot
added
the
size/L
…, never to the package
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue number: closes #8716
Summary
Changes
docs/adr/with seven one-page ADRs for the premises I kept re-explaining in reviews this month: Lambda first, every millisecond counts, Python versions follow the Lambda runtimes, layer and packaging, tests are a contract, zero regression and backwards compatibility, lean dependencies. Plus an index with the rule for adding more: one record every time a maintainer explains the same decision twice.AGENTS.mdat the root, pointer-style: commands, what a PR needs to pass CI, the things we do not do, and how to verify a change.CLAUDE.mdis one line importing it.README.mdandCONTRIBUTING.md: AI-assisted issues and PRs are welcome, say so, and tell us how you verified the change.Verificationsection; the bug report template asks whether the reproduction was actually run.mkdocs.ymlexcludesdocs/adr/from the published site. The records live in the repository only for now.No code or public API changes.
User experience
Someone opening a PR today has to find our rules in old PR threads or hear them in review. After this they are in the repository: a short file for the rules, a page per premise for the why, and the templates ask for the two things that make a review fast, how it was verified and whether an assistant was involved.
Verification
Docs build with
zensical buildpasses and noadr/pages end up insite/.markdownlintondocs,AGENTS.md,README.md,CONTRIBUTING.mdand the PR template passes. Pre-commit hooks pass except the docker-based ones, which I ran by hand. Written by me with an AI assistant; every statement in the ADRs comes from a decision made in an issue or PR this year, and I re-read each one against the code.By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.