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

[David Justo via llvm-commits]

https://github.com/davidmrdavid updated https://github.com/llvm/llvm-project/pull/164328

>From a1fc6dd38954be07ba8a18ba9c45da3d713283d9 Mon Sep 17 00:00:00 2001
From: David Justo <david.justo.1996 at gmail.com>
Date: Mon, 20 Oct 2025 15:20:57 -0700
Subject: [PATCH 1/4] [Docs] [Developer Policy] Document best practice of not
 tagging a username in commit messages and PR descriptions

---
 llvm/docs/DeveloperPolicy.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst
index b94e79e5e7bd5..c1d56334a0d92 100644
--- a/llvm/docs/DeveloperPolicy.rst
+++ b/llvm/docs/DeveloperPolicy.rst
@@ -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
+  every time the commit is cherry-picked and to a fork.
+
 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

>From f2b6af3b1e48039008dc7141dcf0b2cbeac4c590 Mon Sep 17 00:00:00 2001
From: David Justo <david.justo.1996 at gmail.com>
Date: Tue, 21 Oct 2025 09:06:43 -0700
Subject: [PATCH 2/4] incorporate feedabck: "e.g." should be "e.g.,"

Co-authored-by: Jakub Kuderski <kubakuderski at gmail.com>
---
 llvm/docs/DeveloperPolicy.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst
index c1d56334a0d92..2225449bfb16f 100644
--- a/llvm/docs/DeveloperPolicy.rst
+++ b/llvm/docs/DeveloperPolicy.rst
@@ -414,7 +414,7 @@ Below are some guidelines about the format of the message itself:
   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
+  (e.g., `@<someUser>`), doing so results in that account receiving an email
   every time the commit is cherry-picked and to a fork.
 
 LLVM uses a squash workflow for pull requests, so as the pull request evolves

>From 9a42646facd868f746f04055643fa2b8f2096468 Mon Sep 17 00:00:00 2001
From: David Justo <david.justo.1996 at gmail.com>
Date: Tue, 21 Oct 2025 09:09:00 -0700
Subject: [PATCH 3/4] apply feedback: replace 'email' with 'notification'

---
 llvm/docs/DeveloperPolicy.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst
index 2225449bfb16f..92dcfd51430bd 100644
--- a/llvm/docs/DeveloperPolicy.rst
+++ b/llvm/docs/DeveloperPolicy.rst
@@ -414,7 +414,7 @@ Below are some guidelines about the format of the message itself:
   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
+  (e.g., `@<someUser>`), doing so results in that account receiving a notification
   every time the commit is cherry-picked and to a fork.
 
 LLVM uses a squash workflow for pull requests, so as the pull request evolves

>From f8cdebc13140f79853f749199b0e0da93d362f42 Mon Sep 17 00:00:00 2001
From: David Justo <david.justo.1996 at gmail.com>
Date: Tue, 21 Oct 2025 09:10:27 -0700
Subject: [PATCH 4/4] fix grammar, sentence should read: '[..] every time the
 commit is cherry-picked and/or pushed to a fork'

---
 llvm/docs/DeveloperPolicy.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst
index 92dcfd51430bd..45f2df20984e6 100644
--- a/llvm/docs/DeveloperPolicy.rst
+++ b/llvm/docs/DeveloperPolicy.rst
@@ -415,7 +415,7 @@ Below are some guidelines about the format of the message itself:
 
 * Avoid 'tagging' someone's username in your commits and PR descriptions
   (e.g., `@<someUser>`), doing so results in that account receiving a notification
-  every time the commit is cherry-picked and to a fork.
+  every time the commit is cherry-picked and/or pushed to a fork.
 
 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