procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Clarify "ChangeLog entries" in CONTRIBUTE.

Browse source
This commit is contained in:
Eli Zaretskii 2024-02-08 21:07:10 +02:00
parent e268231686
commit 571ec583d6
1 changed files with 16 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
CONTRIBUTE
View file

@ -184,8 +184,9 @@ Here is an example commit message (indented):
Deactivate the mark. Deactivate the mark.
Occasionally, commit messages are collected and prepended to a Occasionally, commit messages are collected and prepended to a
ChangeLog file, where they can be corrected. It saves time to get generated ChangeLog file, where they can be corrected. It saves time
them right the first time, so here are guidelines for formatting them: to get them right the first time, so here are guidelines for
formatting them:
- Start with a single unindented summary line explaining the change; - Start with a single unindented summary line explaining the change;
do not end this line with a period. If possible, try to keep the do not end this line with a period. If possible, try to keep the
@ -194,9 +195,10 @@ them right the first time, so here are guidelines for formatting them:
contexts. contexts.
If the summary line starts with a semicolon and a space "; ", the If the summary line starts with a semicolon and a space "; ", the
commit message will be ignored when generating the ChangeLog file. commit message will be skipped and not added to the generated
Use this for minor commits that do not need separate ChangeLog ChangeLog file. Use this for minor commits that do not need to be
entries, such as changes in etc/NEWS. mentioned in the ChangeLog file, such as changes in etc/NEWS, typo
fixes, etc.
- After the summary line, there should be an empty line. - After the summary line, there should be an empty line.
@ -211,8 +213,8 @@ them right the first time, so here are guidelines for formatting them:
enforced by a commit hook. enforced by a commit hook.
- If only a single file is changed, the summary line can be the normal - If only a single file is changed, the summary line can be the normal
file first line (starting with the asterisk). Then there is no file first line (starting with the asterisk). Then there will be no
individual files section. individual ChangeLog entries beyond the one in the summary line.
- If the commit has more than one author, the commit message should - If the commit has more than one author, the commit message should
contain separate lines to mention the other authors, like the contain separate lines to mention the other authors, like the
@ -245,10 +247,10 @@ them right the first time, so here are guidelines for formatting them:
the rationale for a change; that can be done in the commit message the rationale for a change; that can be done in the commit message
between the summary line and the file entries. between the summary line and the file entries.
- Emacs generally follows the GNU coding standards for ChangeLogs: see - Emacs follows the GNU coding standards for ChangeLog entries: see
https://www.gnu.org/prep/standards/html_node/Change-Logs.html https://www.gnu.org/prep/standards/html_node/Change-Logs.html or run
or run 'info "(standards)Change Logs"'. One exception is that 'info "(standards)Change Logs"'. One exception is that commits
commits still sometimes quote `like-this' (as the standards used to still sometimes quote `like-this' (as the standards used to
recommend) rather than 'like-this' or ‘like this’ (as they do now), recommend) rather than 'like-this' or ‘like this’ (as they do now),
as `...' is so widely used elsewhere in Emacs. as `...' is so widely used elsewhere in Emacs.
@ -261,9 +263,9 @@ them right the first time, so here are guidelines for formatting them:
in Emacs; that includes spelling and leaving 2 blanks between in Emacs; that includes spelling and leaving 2 blanks between
sentences. sentences.
They are preserved indefinitely, and have a reasonable chance of The ChangeLog entries are preserved indefinitely, and have a
being read in the future, so it's better that they have good reasonable chance of being read in the future, so it's better that
presentation. they have good presentation.
- Use the present tense; describe "what the change does", not "what - Use the present tense; describe "what the change does", not "what
the change did". the change did".