diff options
| author | Paul Eggert | 2015-03-29 13:03:55 -0700 |
|---|---|---|
| committer | Paul Eggert | 2015-03-29 13:07:21 -0700 |
| commit | 6b7dd51e1210e962c83b1337c8fa59f1ab65c735 (patch) | |
| tree | f8210b9afa45cf5d0ce56806be5bd5f4f7121b9c /CONTRIBUTE | |
| parent | d193f52f78ff3568ad1e98e5443864ff47b6cf3a (diff) | |
| download | emacs-6b7dd51e1210e962c83b1337c8fa59f1ab65c735.tar.gz emacs-6b7dd51e1210e962c83b1337c8fa59f1ab65c735.zip | |
Fix 'commit-msg' to cite 'CONTRIBUTE'
As suggested in:
http://lists.gnu.org/archive/html/emacs-devel/2015-03/msg00947.html
Also, have the two files match better.
* CONTRIBUTE: Match what's in build-aux/git-hooks/commit-msg.
* build-aux/git-hooks/commit-msg: Mention 'CONTRIBUTE'.
Diffstat (limited to 'CONTRIBUTE')
| -rw-r--r-- | CONTRIBUTE | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/CONTRIBUTE b/CONTRIBUTE index 7c40227b6d9..c72314367a4 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE | |||
| @@ -37,16 +37,17 @@ specify the actual author; the committer defaults to you. | |||
| 37 | When using git, commit messages should use ChangeLog format, with the | 37 | When using git, commit messages should use ChangeLog format, with the |
| 38 | following modifications: | 38 | following modifications: |
| 39 | 39 | ||
| 40 | - Add a single short line explaining the change, then an empty line, | 40 | - Start with a single unindented summary line explaining the change, |
| 41 | then unindented ChangeLog entries. | 41 | then an empty line, then unindented ChangeLog entries. |
| 42 | 42 | ||
| 43 | You can use various Emacs functions to ease this process; see (info | 43 | You can use various Emacs functions to ease this process; see (info |
| 44 | "(emacs)Change Log Commands") or | 44 | "(emacs)Change Log Commands") or |
| 45 | http://www.gnu.org/software/emacs/manual/html_node/emacs/Change-Log-Commands.html. | 45 | http://www.gnu.org/software/emacs/manual/html_node/emacs/Change-Log-Commands.html. |
| 46 | 46 | ||
| 47 | - The summary line is limited to 72 characters (enforced by a commit | 47 | - Limit lines in commit messages to 78 characters, unless they consist |
| 48 | hook). If you have trouble making that a good summary, add a | 48 | of a single word of at most 140 characters. If you have trouble |
| 49 | paragraph below it, before the individual file descriptions. | 49 | fitting the summary into 78 characters, add a summarizing paragraph |
| 50 | below the empty line and before the individual file descriptions. | ||
| 50 | 51 | ||
| 51 | - If only a single file is changed, the summary line can be the normal | 52 | - If only a single file is changed, the summary line can be the normal |
| 52 | file first line (starting with the asterisk). Then there is no | 53 | file first line (starting with the asterisk). Then there is no |
| @@ -57,6 +58,11 @@ following modifications: | |||
| 57 | the rationale for a change; that can be done in the commit message | 58 | the rationale for a change; that can be done in the commit message |
| 58 | between the summary line and the file entries. | 59 | between the summary line and the file entries. |
| 59 | 60 | ||
| 61 | - Commit messages should contain only printable UTF-8 characters. | ||
| 62 | |||
| 63 | - Commit messages should not contained the "Signed-off-by:" lines that | ||
| 64 | are used in some other projects. | ||
| 65 | |||
| 60 | ** ChangeLog notes | 66 | ** ChangeLog notes |
| 61 | 67 | ||
| 62 | - Emacs generally follows the GNU coding standards when it comes to | 68 | - Emacs generally follows the GNU coding standards when it comes to |