Skip to content

docs: explain BEGIN_COMMIT_OVERRIDE for PRs with several changes - #2445

Draft
kikoso wants to merge 1 commit into
mainfrom
docs/agents-commit-override
Draft

kikoso wants to merge 1 commit into
mainfrom
docs/agents-commit-override

Conversation

@kikoso

@kikoso kikoso commented Oct 1, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds a rule to the "Pull requests" section of AGENTS.md: when a PR contains several changes that belong in the changelog separately, add a BEGIN_COMMIT_OVERRIDE / END_COMMIT_OVERRIDE block to the PR description, one Conventional Commit per line.

A squash merge keeps only the PR title, so without the block release-please lists a single entry for the whole PR. The rule also notes that the PR title must still be a valid Conventional Commit, and that each override line counts toward the version bump.

Same rule as googlemaps/android-maps-utils#1810.

A squash merge keeps only the PR title, so release-please lists one
changelog entry per PR. Document the commit override block for PRs that
contain several changes that should be listed separately.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant