[PATCH] D155081: Specify the developer policy around links to external resources

[Aaron Ballman via Phabricator via cfe-commits]

aaron.ballman updated this revision to Diff 549365.
aaron.ballman marked 2 inline comments as done.
aaron.ballman added a comment.

Updated based on review comments.


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D155081/new/

https://reviews.llvm.org/D155081

Files:
  llvm/docs/DeveloperPolicy.rst


Index: llvm/docs/DeveloperPolicy.rst
===================================================================
--- llvm/docs/DeveloperPolicy.rst
+++ llvm/docs/DeveloperPolicy.rst
@@ -354,14 +354,16 @@
   related commit. This could be as simple as "Revert commit NNNN because it
   caused PR#".
 
-* It is acceptable to add metadata to the commit message to automate processes.
-  If the patch fixes a bug in GitHub Issues, we encourage adding
+* It is acceptable to add metadata to the commit message to automate processes,
+  including for downstream consumers. If the patch fixes a bug in GitHub Issues,
+  we encourage adding
   "Fixes https://github.com/llvm/llvm-project/issues/12345" to automate closing
   the issue in GitHub. If the patch has been reviewed, we encourage adding a
   link to its review page, as shown
   `here <https://www.llvm.org/docs/Phabricator.html#committing-a-change>`_.
   Other kinds of metadata are also acceptable, including links to resources
-  that are not available to the entire community.
+  that are not available to the entire community. However, such links should
+  not be used in place of making the commit message self-explanatory.
 
 For minor violations of these recommendations, the community normally favors
 reminding the contributor of this policy over reverting. Minor corrections and


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D155081.549365.patch
Type: text/x-patch
Size: 1333 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20230811/eef2ee72/attachment.bin>