[llvm] [docs] Refresh Developer Policy text (PR #136198)

Oleksandr Alex Zinenko via llvm-commits llvm-commits at lists.llvm.org
Fri Apr 18 01:24:00 PDT 2025


================
@@ -336,12 +341,12 @@ you follow these guidelines to help review, search in logs, email formatting
 and so on. These guidelines are very similar to rules used by other open source
 projects.
 
-Most importantly, the contents of the message should be carefully written to
-convey the rationale of the change (without delving too much in detail). It
-also should avoid being vague or overly specific. For example, "bits were not
-set right" will leave the reviewer wondering about which bits, and why they
-weren't right, while "Correctly set overflow bits in TargetInfo" conveys almost
-all there is to the change.
+Commit messages should communicate briefly what the change does, and provide
----------------
ftynse wrote:

IMO, the "why" part is the most important in the commit message. We can understand the "what" from the commit itself, although it is useful to summarize the "what" in the message for the reviewer to check whether the code actually does what the author intended.


https://github.com/llvm/llvm-project/pull/136198


More information about the llvm-commits mailing list