Skip to content

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

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

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.

@github-actions

github-actions Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Coverage (unit tests)

Compared against 597c8db on main (#1023).

Module Line % Change Branch % Change
maps-compose 0.00% no change 0.00% no change
maps-compose-utils 2.04% no change 0.49% no change
maps-compose-widgets 0.00% no change 0.00% no change
TOTAL 0.42% no change 0.09% no change

Line and branch coverage from unit test reports. History is recorded on the coverage-history branch after each merge to main.

@googlemaps-bot

googlemaps-bot commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

Code Coverage

Overall Project 44.41% 🍏

There is no coverage information present for the Files changed

@dkhawk
dkhawk force-pushed the docs/agents-commit-override branch from c3ffe6d to 109efd2 Compare October 1, 2026 21:07
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.
@kikoso
kikoso force-pushed the docs/agents-commit-override branch from 109efd2 to 1d37b26 Compare October 2, 2026 02:28
@kikoso
kikoso marked this pull request as ready for review October 2, 2026 02:28

This branch has not been deployed

No deployments
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.

3 participants