[llvm] bf1a554 - Document the requirement that commits have a public email address (#109318)

via llvm-commits llvm-commits at lists.llvm.org
Thu Oct 17 09:25:26 PDT 2024


Author: Aaron Ballman
Date: 2024-10-17T12:25:22-04:00
New Revision: bf1a554312bd011cb2016a2c9d7e75d6fe3b02af

URL: https://github.com/llvm/llvm-project/commit/bf1a554312bd011cb2016a2c9d7e75d6fe3b02af
DIFF: https://github.com/llvm/llvm-project/commit/bf1a554312bd011cb2016a2c9d7e75d6fe3b02af.diff

LOG: Document the requirement that commits have a public email address (#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.

Added: 
    

Modified: 
    llvm/docs/DeveloperPolicy.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/DeveloperPolicy.rst b/llvm/docs/DeveloperPolicy.rst
index caa4b31b949c92..0ecf1423e60371 100644
--- a/llvm/docs/DeveloperPolicy.rst
+++ b/llvm/docs/DeveloperPolicy.rst
@@ -105,6 +105,13 @@ When submitting patches, please do not add confidentiality or non-disclosure
 notices to the patches themselves.  These notices conflict with the LLVM
 licensing terms and may result in your contribution being excluded.
 
+The LLVM project uses email to communicate to contributors outside of the
+GitHub platform about their past contributions. Primarily, our buildbot
+infrastructure uses emails to contact contributors about build and test
+failures. Therefore, the LLVM community requires contributors to have a public
+email address 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>`_.
 
 .. _code review:
 


        


More information about the llvm-commits mailing list