Skip to content

Commit a1fc6dd

Browse files
authored
[Docs] [Developer Policy] Document best practice of not tagging a username in commit messages and PR descriptions
1 parent 437cad9 commit a1fc6dd

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

llvm/docs/DeveloperPolicy.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -413,6 +413,10 @@ Below are some guidelines about the format of the message itself:
413413
message self-explanatory. Note that such non-public links should not be
414414
included in the submitted code.
415415

416+
* Avoid 'tagging' someone's username in your commits and PR descriptions
417+
(e.g. `@<someUser>`), doing so results in that account receiving an email
418+
every time the commit is cherry-picked and to a fork.
419+
416420
LLVM uses a squash workflow for pull requests, so as the pull request evolves
417421
during review, it's important to update the pull request description over the
418422
course of a review. GitHub uses the initial commit message to create the pull

0 commit comments

Comments
 (0)