Skip to content

[Docs] [Developer Policy] Document best practice of not tagging a username in commit messages and PR descriptions #164328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 21, 2025
Merged

[Docs] [Developer Policy] Document best practice of not tagging a username in commit messages and PR descriptions #164328

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a1fc6dd
[Docs] [Developer Policy] Document best practice of not tagging a use…
davidmrdavid Oct 20, 2025
f2b6af3
incorporate feedabck: "e.g." should be "e.g.,"
davidmrdavid Oct 21, 2025
9a42646
apply feedback: replace 'email' with 'notification'
davidmrdavid Oct 21, 2025
f8cdebc
fix grammar, sentence should read: '[..] every time the commit is che…
davidmrdavid Oct 21, 2025
65ceb11
Merge branch 'main' into dev/dajusto/document-that-usernames-should-n…
davidmrdavid Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions llvm/docs/DeveloperPolicy.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -413,6 +413,10 @@ Below are some guidelines about the format of the message itself:
message self-explanatory. Note that such non-public links should not be
included in the submitted code.

* Avoid 'tagging' someone's username in your commits and PR descriptions
(e.g. `@<someUser>`), doing so results in that account receiving an email
Copy link
Member

@kuhar kuhar Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have almost all email notification disabled but still receive github notifications. Maybe s/an email/a notification/`?

Copy link
Contributor Author

@davidmrdavid davidmrdavid Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good point, replaced here: 9a42646

thanks!

every time the commit is cherry-picked and to a fork.
Copy link
Collaborator

@jh7370 jh7370 Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "and" here seems misplaced?

Copy link
Contributor Author

@davidmrdavid davidmrdavid Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, yes. That was a typo. It should read: "[...] the commit is cherry-picked and/or pushed to a fork".

Fixed here: f8cdebc


LLVM uses a squash workflow for pull requests, so as the pull request evolves
during review, it's important to update the pull request description over the
course of a review. GitHub uses the initial commit message to create the pull
Expand Down
Loading