[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#20328: outdated CONTRIBUTE info re ChangeLogs
From: |
Dmitry Gutov |
Subject: |
bug#20328: outdated CONTRIBUTE info re ChangeLogs |
Date: |
Wed, 15 Apr 2015 02:26:28 +0300 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:36.0) Gecko/20100101 Thunderbird/36.0 |
On 04/14/2015 09:25 AM, Glenn Morris wrote:
CONTRIBUTE contains outdated information re ChangeLogs.
Someone should review it and update it.
I don't know if they're all actually incorrect. Based on an non-obvious
distinction - yes.
Since a commit message contains a summary, maybe a few headers, and a
ChangeLog entry, it's fair to describe what a "ChangeLog entry" should
contain.
Random hits (almost every instance related to "ChangeLog" seems wrong to me):
If committing changes written by someone else, make the ChangeLog
entry in their name, not yours.
Right, there's no separate name line in the ChangeLog entries inside
commit messages. Updated.
[...]
It is tempting to relax this rule for commit messages, since they
are somewhat transient.
This one actually seemed outdated. Removed.
[...]
In ChangeLog entries, there is no standard or recommended way to
identify revisions.
This still applies. Even though it could say "in commit messages", this
also emphasized the fact that the same non-sandardized references will
appear in the ChangeLog file.
[...]
There is no need to make separate ChangeLog entries for files such
as NEWS, MAINTAINERS...
Still true, and I'm not sure how to rephrase this to refer to commit
messages.