Repository navigation
docs: add rules for every change - #840
Merged
Merged
Conversation
Copy the rules for every change from the JS SDK, so both SDKs ask the same of people and coding agents. - CONTRIBUTING.md gets the section "Rules for every change" with the same 9 rules. Two sentences are left out because they point to JS-only material: the ADR folder and the SDK invariants section. - A new .github/pull_request_template.md replaces the aws organization's default template for this repository. It keeps the default's prompts and license sentence, and adds the Design, Assumptions and Decisions sections and three checklist items from the JS template. - AGENTS.md links to the new section. Documentation only.
Contributor
Codex AI reviewNo actionable findings. The changes affect only contribution guidance and the PR template, with no identified runtime regression risk. Tests were not run, as requested. Reviewed commit |
ParidelPooya
approved these changes
Oct 25, 2026
This branch was successfully deployed
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 #, if available
None.
Description of changes
This PR copies the rules for every change from JS SDK PR #1094: add rules for every change to CONTRIBUTING and the PR template. The rules keep each change as small as the problem, for people and for coding agents.
CONTRIBUTING.mdgets the section "Rules for every change", under "Contributing via Pull Requests". It has the same 9 rules as the JS SDK. Two sentences are left out, because they point to material that only the JS repository has:.github/pull_request_template.mdgives the repository its own template. Until now, GitHub used the aws organization's default template, which asks only for an issue and a description. The new template keeps those two prompts and the default's license sentence. It adds the Design, Assumptions and Decisions sections and the three checklist items from the JS template.AGENTS.mdlinks to the new section from its "Working in this repository" list.No code changes.
Design
CONTRIBUTING.mdsection, without a template. Rejected, because the template is where a contributor writes the design, the assumptions and the decisions.Assumptions
.github/pull_request_template.md(GitHub docs: creating a pull request template). It uses the organization default only when a repository has no template of its own (GitHub docs: creating a default community health file). The template takes effect once it is onmain.Decisions not covered by the issue or the design note
.github/prompts/ai-pr-review.mdis unchanged. It already tells the AI reviewer to readCONTRIBUTING.mdfrom the base branch. So the reviewer reads the rules once this PR is merged.Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.