[llvm] Document the requirement that commits have a public email address (PR #109318)
Aaron Ballman via llvm-commits
llvm-commits at lists.llvm.org
Thu Sep 19 11:37:22 PDT 2024
https://github.com/AaronBallman created https://github.com/llvm/llvm-project/pull/109318
See https://discourse.llvm.org/t/hidden-emails-on-github-should-we-do-something-about-it/74223 for details about why this is important to the community.
Note, we currently have soft enforcement for this requirement in the form of a bot which posts comments letting patch authors know their email is private, so we're already setting expectations in practice; this PR is documenting those expectations for clarity.
>From c137dc63c95156e220a4e8474162042f2d5445cf Mon Sep 17 00:00:00 2001
From: Aaron Ballman <aaron at aaronballman.com>
Date: Thu, 19 Sep 2024 14:14:07 -0400
Subject: [PATCH 1/2] Document the requirement that emails be public
See https://discourse.llvm.org/t/hidden-emails-on-github-should-we-do-something-about-it/74223
for details about why this is useful.
Note, we currently have soft enforcement for this requirement in the
form of a bot which posts comments letting patch authors know their
email is private.
---
llvm/docs/DeveloperPolicy.rst | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst
index caa4b31b949c92..86335ab8b868fd 100644
--- a/llvm/docs/DeveloperPolicy.rst
+++ b/llvm/docs/DeveloperPolicy.rst
@@ -86,6 +86,11 @@ that notices of confidentiality or non-disclosure cannot be respected.
Making and Submitting a Patch
-----------------------------
+The LLVM community requires contributors to have a public email address
+associated with their GitHub account. Please ensure that "Keep my email
+addresses private" is disabled in your
+`account settings <https://github.com/settings/emails>`_.
+
When making a patch for review, the goal is to make it as easy for the reviewer
to read it as possible. As such, we recommend that you:
>From 12a4a3ce6c25e817a82e8282c06c23857079a2d3 Mon Sep 17 00:00:00 2001
From: Aaron Ballman <aaron at aaronballman.com>
Date: Thu, 19 Sep 2024 14:32:09 -0400
Subject: [PATCH 2/2] Slight wording tweak for clarity
---
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 86335ab8b868fd..34bcd507c4e579 100644
--- a/llvm/docs/DeveloperPolicy.rst
+++ b/llvm/docs/DeveloperPolicy.rst
@@ -87,7 +87,7 @@ Making and Submitting a Patch
-----------------------------
The LLVM community requires contributors to have a public email address
-associated with their GitHub account. Please ensure that "Keep my email
+associated with their GitHub commits, so please ensure that "Keep my email
addresses private" is disabled in your
`account settings <https://github.com/settings/emails>`_.
More information about the llvm-commits
mailing list