Skip to content

Commit 32c0c39

Browse files
authored
Mention not @-mentioning people in commit messages in tree hygiene (#151487)
Update style guide to include anti pattern of mentioning someone in a comment and the flurry of notifications that result. Came up in a google contributor roundtable discussion.
1 parent 515c526 commit 32c0c39

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/contributing/Tree-hygiene.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,9 @@ Because `git pull` will often miss tags that are used to define the release of t
130130
Use `git fetch upstream; git rebase upstream/main; git push origin your_branch_name` to update your PRs, rather than using merge, because that way our tooling will recognize your PR as being up to date. (Otherwise it'll try testing against the tests at the time you originally branched.) Also, **be wary of force pushing to your PR branch** if you are dealing with golden image tests; see [gold troubleshooting instructions](./testing/Writing-a-golden-file-test-for-package-flutter.md#troubleshooting).
131131

132132
Please make sure all your patches have detailed commit messages explaining what the problem was and
133-
what the solution is.
133+
what the solution is. (Avoid GitHub @-mentions in commit messages. GitHub turns this into a notification
134+
for the person any time someone rebases your commit on their own fork. On a project of this size, that's
135+
rather disruptive. If you need to @-mention someone, do it as a separate comment on the PR.)
134136

135137
You must complete the
136138
[Contributor License Agreement](https://cla.developers.google.com/clas).

0 commit comments

Comments
 (0)