diff options
| author | Eric S. Raymond | 2014-10-26 20:50:32 -0400 |
|---|---|---|
| committer | Eric S. Raymond | 2014-10-26 20:50:32 -0400 |
| commit | ea1c65d4bb1aeac801d8a969715ec0a4f5b15de9 (patch) | |
| tree | b8e52eaa8fec019d64e6d2281e5a9c1dffe44971 /admin | |
| parent | 12983c77989e47c7c7b6fbe7a0c999036969ffbd (diff) | |
| download | emacs-ea1c65d4bb1aeac801d8a969715ec0a4f5b15de9.tar.gz emacs-ea1c65d4bb1aeac801d8a969715ec0a4f5b15de9.zip | |
Guidance on commit-comment formats.
Diffstat (limited to 'admin')
| -rw-r--r-- | admin/ChangeLog | 3 | ||||
| -rw-r--r-- | admin/notes/repo | 18 |
2 files changed, 20 insertions, 1 deletions
diff --git a/admin/ChangeLog b/admin/ChangeLog index 84a809826a9..6bd5ceaca55 100644 --- a/admin/ChangeLog +++ b/admin/ChangeLog | |||
| @@ -1,7 +1,8 @@ | |||
| 1 | 2014-10-27 Eric S. Raymond <esr@thyrsus.com> | 1 | 2014-10-27 Eric S. Raymond <esr@thyrsus.com> |
| 2 | 2 | ||
| 3 | * notes/bzr: Renamed to notes/repo, reorganixed to separate | 3 | * notes/bzr: Renamed to notes/repo, reorganixed to separate |
| 4 | VCS-dependent from VCS-independent stuff. | 4 | VCS-dependent from VCS-independent stuff. Added guidance about |
| 5 | commit-comment format under DVCSes. | ||
| 5 | 6 | ||
| 6 | * notes/BRANCH: Merged into notes/repo. | 7 | * notes/BRANCH: Merged into notes/repo. |
| 7 | 8 | ||
diff --git a/admin/notes/repo b/admin/notes/repo index 910b092e1ab..2044bb9ea2d 100644 --- a/admin/notes/repo +++ b/admin/notes/repo | |||
| @@ -1,5 +1,23 @@ | |||
| 1 | NOTES ON COMMITTING TO EMACS'S REPOSITORY -*- outline -*- | 1 | NOTES ON COMMITTING TO EMACS'S REPOSITORY -*- outline -*- |
| 2 | 2 | ||
| 3 | * Use DVCS commenting conventions | ||
| 4 | |||
| 5 | Commits should follow the conventions used in all modern distributed | ||
| 6 | version-control systems. That is, they should consist of | ||
| 7 | |||
| 8 | - A self-contained topic line no more than 75 chars long. | ||
| 9 | |||
| 10 | - If other content follows the topic line, there should be | ||
| 11 | a blank line separating the two. | ||
| 12 | |||
| 13 | Try to keep your commits - and your commit comments - small. If | ||
| 14 | you feel an urge to put a bullet list in your commit comment, it's | ||
| 15 | doing too many things at once. | ||
| 16 | |||
| 17 | Yes, these directins are a departure from historical Emacs practice, | ||
| 18 | but it helps modern log-viewing and summary tools work better so that | ||
| 19 | other people can comprehend your code. | ||
| 20 | |||
| 3 | * Commit to the right branch | 21 | * Commit to the right branch |
| 4 | 22 | ||
| 5 | You can view the available Emacs branches at | 23 | You can view the available Emacs branches at |