DeveloperPolicy: Bugreports should be referenced with an URL

[MatzeB]

Summary

Encourage people to use full URLs when referencing problem reports in commit messages. The URL doesn't add much overhead and allows people to click on it when viewing the messages.

[mcrosier]

I'm on board!

[llvm-commits]

I have no problem with the suggestion for the body, but please leave the
PR# bit in the subject. The PR is the least useful part of any subject
to me and I don't want to devote more space to it.

Philip

• msg-7797-143.txt162 BDownload

[MatzeB]

In D19848#421481, @llvm-commits wrote:

I have no problem with the suggestion for the body, but please leave the
PR# bit in the subject. The PR is the least useful part of any subject
to me and I don't want to devote more space to it.

Philip

• msg-7797-143.txt162 BDownload

I fully agree here and the parts I changed talk about the commit message and not the commit title. I'd also say that should be no reason to even mention the PR# in the title. I changed the revert point to explicitly mention that it is about the commit message.

[MatzeB]

ping.

[llvm-commits]

Although I like the change, I proposed something similar in http://lists.llvm.org/pipermail/llvm-dev/2016-May/099752.html and it was rejected.

+Renato, who was opposed the previous patch.

[MatzeB]

This seems to have stalled, abandoning.

docs/DeveloperPolicy.rst

 
 * The body, if it exists, should be separated from the title by an empty line.
 
 * The body should be concise, but explanatory, including a complete
   reasoning.  Unless it is required to understand the change, examples,
   code snippets and gory details should be left to bug comments, web
   review or the mailing list.
 
-* If the patch fixes a bug in bugzilla, please include the PR# in the message.
+* If the patch fixes a bug in bugzilla, please include a reference to
+  http://llvm.org/PR# in the message. Use a full URL rather than just the
+  PR number.
 
 * `Attribution of Changes`_ should be in a separate line, after the end of
   the body, as simple as "Patch by John Doe.". This is how we officially
   handle attribution, and there are automated processes that rely on this
   format.
 
 * Text formatting and spelling should follow the same rules as documentation
   and in-code comments, ex. capitalization, full stop, etc.
 
 * If the commit is a bug fix on top of another recently committed patch, or a
   revert or reapply of a patch, include the svn revision number of the prior
-  related commit. This could be as simple as "Revert rNNNN because it caused
-  PR#".
+  related commit in the message. This could be as simple as "Revert rNNNN
+  because it caused http://llvm.org/PR#".
 
 For minor violations of these recommendations, the community normally favors
 reminding the contributor of this policy over reverting. Minor corrections and
 omissions can be handled by sending a reply to the commits mailing list.
 
 Obtaining Commit Access
 -----------------------