[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] trunk r118222: Guidance on commit-comment formats.
From: |
Eric S. Raymond |
Subject: |
[Emacs-diffs] trunk r118222: Guidance on commit-comment formats. |
Date: |
Mon, 27 Oct 2014 00:50:58 +0000 |
User-agent: |
Bazaar (2.6b2) |
------------------------------------------------------------
revno: 118222
revision-id: address@hidden
parent: address@hidden
committer: Eric S. Raymond <address@hidden>
branch nick: trunk
timestamp: Sun 2014-10-26 20:50:32 -0400
message:
Guidance on commit-comment formats.
modified:
admin/ChangeLog changelog-20091113204419-o5vbwnq5f7feedwu-2226
admin/notes/repo bzr-20100518025134-ebvhi2w74h1r56u7-1
=== modified file 'admin/ChangeLog'
--- a/admin/ChangeLog 2014-10-27 00:27:55 +0000
+++ b/admin/ChangeLog 2014-10-27 00:50:32 +0000
@@ -1,7 +1,8 @@
2014-10-27 Eric S. Raymond <address@hidden>
* notes/bzr: Renamed to notes/repo, reorganixed to separate
- VCS-dependent from VCS-independent stuff.
+ VCS-dependent from VCS-independent stuff. Added guidance about
+ commit-comment format under DVCSes.
* notes/BRANCH: Merged into notes/repo.
=== modified file 'admin/notes/repo'
--- a/admin/notes/repo 2014-10-27 00:27:55 +0000
+++ b/admin/notes/repo 2014-10-27 00:50:32 +0000
@@ -1,5 +1,23 @@
NOTES ON COMMITTING TO EMACS'S REPOSITORY -*- outline -*-
+* Use DVCS commenting conventions
+
+Commits should follow the conventions used in all modern distributed
+version-control systems. That is, they should consist of
+
+- A self-contained topic line no more than 75 chars long.
+
+- If other content follows the topic line, there should be
+ a blank line separating the two.
+
+Try to keep your commits - and your commit comments - small. If
+you feel an urge to put a bullet list in your commit comment, it's
+doing too many things at once.
+
+Yes, these directins are a departure from historical Emacs practice,
+but it helps modern log-viewing and summary tools work better so that
+other people can comprehend your code.
+
* Commit to the right branch
You can view the available Emacs branches at
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] trunk r118222: Guidance on commit-comment formats.,
Eric S. Raymond <=