Repository navigation
Update contributing guidelines for commit message format - #189922
Merged
Merged
Conversation
Clarify formatting rules for commit messages.
github-actions
Bot
added
package
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds a guideline to the contributing documentation stating that code references should use backticks. Feedback on this change identifies a grammatical typo ('backtick's' instead of 'backticks') and a trailing space, proposing a corrected version.
| - Entries should end with a `.`. | ||
| - Breaking changes should be introduced with `**BREAKING CHANGE**:`, or `**BREAKING CHANGES**:` if there is a sub-list of changes. | ||
| - Breaking change notifications should include information about how to migrate. If extensive migration is required, this can be a reference to a longer description elsewhere (usually README.md) rather than inline instructions. | ||
| - Code references should use backtick's. |
Contributor
There was a problem hiding this comment.
There is a grammatical typo in this line: "backtick's" should be plural "backticks". Additionally, there is a trailing space at the end of the line which should be removed.
Suggested change
| - Code references should use backtick's. | |
| - Code references should use backticks. |
Contributor
Author
There was a problem hiding this comment.
lol @stuartmorgan-g and gemini-code-assist agree. What is embarrassing is I had that first and "corrected" it. 🤦
stuartmorgan-g
previously approved these changes
Jul 23, 2026
stuartmorgan-g
left a comment
stuartmorgan-g
left a comment
Contributor
There was a problem hiding this comment.
LGTM with typo fix.
reidbaker
added
the
autosubmit
This was referenced Jul 23, 2026
auto-submit
Bot
removed
the
autosubmit
Contributor
|
autosubmit label was removed for flutter/flutter/189922, because - The status or check suite Tree_analyze has failed. Please fix the issues identified (or deflake) before re-applying this label.
|
reidbaker
pushed a commit
to flutter/packages
that referenced
this pull request
Jul 23, 2026
*Adds links to the official Flutter CHANGELOG style guidelines to the AGENTS.md document to clarify formatting rules for agents and contributors.* Tests for AGENTS.md on the roadmap but do not exist for this repo yet. If we had evals then this pr would also contain a new expectation that an expected code reference in a changelog does contain `codeReference`. This pr and flutter/flutter#189922 are both to fix https://github.com/flutter/packages/pull/12145/changes#r3625889893 ## Pre-Review Checklist - [x] I read the Contributor Guide and followed the process outlined there for submitting PRs. - [x] I read the AI contribution guidelines and understand my responsibilities, or I am not using AI tools. - [x] I read the Tree Hygiene page, which explains my responsibilities. - [x] I read and followed the relevant style guides and ran the auto-formatter. - [x] I signed the CLA. - [x] The title of the PR starts with the name of the package surrounded by square brackets, e.g. `[shared_preferences]` - [ ] I linked to at least one issue that this PR fixes in the description above. - [x] I followed the version and CHANGELOG instructions, using semantic versioning and the repository CHANGELOG style, or I have commented below to indicate which documented exception this PR falls under. - [x] I updated/added any relevant documentation (doc comments with `///`). - [ ] I added new tests to check the change I am making, or I have commented below to indicate which test exemption this PR falls under. - [x] All existing and new tests are passing.
Zubii12
pushed a commit
to Zubii12/packages
that referenced
this pull request
Jul 23, 2026
*Adds links to the official Flutter CHANGELOG style guidelines to the AGENTS.md document to clarify formatting rules for agents and contributors.* Tests for AGENTS.md on the roadmap but do not exist for this repo yet. If we had evals then this pr would also contain a new expectation that an expected code reference in a changelog does contain `codeReference`. This pr and flutter/flutter#189922 are both to fix https://github.com/flutter/packages/pull/12145/changes#r3625889893 ## Pre-Review Checklist - [x] I read the Contributor Guide and followed the process outlined there for submitting PRs. - [x] I read the AI contribution guidelines and understand my responsibilities, or I am not using AI tools. - [x] I read the Tree Hygiene page, which explains my responsibilities. - [x] I read and followed the relevant style guides and ran the auto-formatter. - [x] I signed the CLA. - [x] The title of the PR starts with the name of the package surrounded by square brackets, e.g. `[shared_preferences]` - [ ] I linked to at least one issue that this PR fixes in the description above. - [x] I followed the version and CHANGELOG instructions, using semantic versioning and the repository CHANGELOG style, or I have commented below to indicate which documented exception this PR falls under. - [x] I updated/added any relevant documentation (doc comments with `///`). - [ ] I added new tests to check the change I am making, or I have commented below to indicate which test exemption this PR falls under. - [x] All existing and new tests are passing.
reidbaker
added
the
autosubmit
Contributor
|
autosubmit label was removed for flutter/flutter/189922, because - The status or check suite Tree_analyze has failed. Please fix the issues identified (or deflake) before re-applying this label.
|
auto-submit
Bot
removed
the
autosubmit
reidbaker
added
the
autosubmit
flutter-dashboard
Bot
removed
the
autosubmit
auto-submit Bot
pushed a commit
to flutter/packages
that referenced
this pull request
Jul 25, 2026
flutter/flutter@b65f4d9...e292197 2026-07-25 [email protected] Roll Skia from 2c014dc494f1 to 62442d6cf0ec (1 revision) (flutter/flutter#190022) 2026-07-25 [email protected] Roll Skia from d8d20eef4dbd to 2c014dc494f1 (1 revision) (flutter/flutter#190020) 2026-07-25 [email protected] [Impeller] Add 2D texture array support (kTexture2DArray) (flutter/flutter#188778) 2026-07-24 [email protected] Bumped Engine AGP Dependencies to 9.1.0 for 3.50 (flutter/flutter#189417) 2026-07-24 [email protected] Roll Dart SDK from 153abd9a8296 to 28e63ac22d8d (2 revisions) (flutter/flutter#190013) 2026-07-24 [email protected] ci: add mac verify binaries workflow (flutter/flutter#190010) 2026-07-24 [email protected] Roll Skia from f2f9b52fe1ee to d8d20eef4dbd (21 revisions) (flutter/flutter#190011) 2026-07-24 [email protected] fix(ci): quote labels to fix yaml mapping error (flutter/flutter#190002) 2026-07-24 [email protected] Update contributing guidelines for commit message format (flutter/flutter#189922) 2026-07-24 [email protected] Migrate a11y_assessments to uiscene (flutter/flutter#189960) 2026-07-24 [email protected] docs(contributing): add git worktree and rebase workflow guide (flutter/flutter#189992) 2026-07-24 [email protected] Roll Dart SDK from e3fc57eae9eb to 153abd9a8296 (3 revisions) (flutter/flutter#189987) 2026-07-24 [email protected] Rename RegularWindow* to Window* in the windowing API + rename sizedToContent to shrinkWrap in the windowing API (flutter/flutter#189363) 2026-07-24 [email protected] Remove ancient `tools:tools` dep from `android_sdk` bundle (flutter/flutter#189962) 2026-07-24 [email protected] Reduce the number of gtest-parallel workers when running Impeller tests on Mac Minis used by CI (flutter/flutter#189813) 2026-07-24 [email protected] Roll Packages from 8260a1e to 6969329 (21 revisions) (flutter/flutter#189983) 2026-07-24 [email protected] Roll Fuchsia Linux SDK from 9org0yL3yZkp80x5S... to Cdb1RGKCqpcz9z4cl... (flutter/flutter#189975) 2026-07-24 [email protected] Roll Skia from 6e9c4687c001 to f2f9b52fe1ee (3 revisions) (flutter/flutter#189959) 2026-07-24 [email protected] [web] Cancel touch pointers WebKit abandons mid-gesture (flutter/flutter#189608) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
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
3 participants
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.
This style of putting code terms in backticks is implied not stated.
https://github.com/flutter/packages/pull/12145/changes#r3625889893