Differences

This shows you the differences between two versions of the page.

--- commitmessageformat [2007/06/08 20:44] – AndrewPantyukhin
+++ commitmessageformat [2022/11/27 23:09] (current) – Overview: update with Git in mind. GrahamPerrin
@@ Line 1: / Line 1: @@
 ===== Commit Message Format =====
+**This page is not authoritative. It is rather a collection of reasonable suggestions.** Feel free to contribute to this page.
 There's little technical merit to a standardized commit log format, except for much easier grepping. What we should value here is tradition.
 ==== Overview ====
 <code>
-- Did that
+Summary, ~50 characters, no trailing punctuation
-- And that
+This, that. A blank line between the summary line, and this first
+piece of free-form text. Hard wrap at 72 characters.
+The other. Again, 72 characters. A blank line between this final
+piece of free-form text, and the colon-separated fields.
-Field one: value
+First field:  value
-Field two: value
+Second field: value
 </code>
@@ Line 32: / Line 39: @@
   * If committer==submitter, the "Submitted by" field may be omitted
   * Don't use pronouns in field values
-  * Use a spell-chekcer
+  * Use a spell-checker
   * Limit characters to US-ASCII
   * Use present tense
@@ Line 39: / Line 46: @@
   * Use proper capitalization. In particular, start sentences with capital letters.
   * Use %%FreeBSD%% aliases instead of names whenever possible
+  * Use lowercased make variable names when there is no ambiguity (e.g. "portrevision")
 ==== Do ====
 <code>
-PR:           ports/12345
+PR:           12345
 Approved by:  John Doe <john@doe.org> (maintainer)
 Approved by:  phk (maintainer, implicit)
 Approved by:  portmgr (erwin)
-Approved by:  Dow Jones (maitainer timeout, 25 days)
+Approved by:  Dow Jones (maintainer timeout, 25 days)
 Submitted by: Jane Doe <jane@doe.org>
 </code>
@@ Line 53: / Line 61: @@
 <code>
-PR:           12345
 Approved by:  maintainer
 Approved by:  maintainer timeout
@@ Line 63: / Line 70: @@
 <code>
 Reported by:  pointyhat via kris
+Reported by:  pointyhat logs
+Reported by:  portsmon
 Submitted by: Ports Fury
 </code>
@@ Line 73: / Line 82: @@
 | Abc doesn't work, fix it! | Reported by: jack |
 | Here's a patch | Submitted by: jack |
+  * A maintainer sends a PR. You want to commit it with additional changes. The maintainer approves them:
+<code>
+- Update to 1.5 [1]
+- Replace deprecated variable: INSTALLS_SHLIB [2]
+- Use PORTDOCS to simplify pkg-plist [2]
+PR:            ports/113760 [1]
+Submitted by:  Antoine Brodin <brodin@leposte.net> (maintainer) [1]
+Approved by:   Antoine Brodin <brodin@leposte.net> (maintainer) [2]
+</code>
+==== Standard text excerpts ====
+<code>
+- Update to 1.2.3
+- Take maintainership
+- Pass maintainership to submitter
+- Drop maintainership
+Add port foo/bar: <pkg-descr follows>
+- Connect foo/bar to the build
+- Bump portrevision
+- Fix plist
+- Add rc script
+</code>
+----
+{{tag>HowTo}}
+{{tag>Stale}}