|
From: | Jim Porter |
Subject: | Re: master 9ccaa09a635: ; .dir-locals.el (log-edit-mode) <fill-column>: Set to 64. |
Date: | Wed, 7 Feb 2024 22:13:01 -0800 |
On 2/7/2024 7:34 PM, Po Lu wrote:
Jim Porter <jporterbugs@gmail.com> writes:I don't have a terribly strong opinion here of what number to use, but we should at least resolve the inconsistencies in CONTRIBUTE, .dir-locals.el, and build-aux/git-hooks/commit-msg.commit-msg is fine as-is, but CONTRIBUTE should be fixed.
I think I understand now. I find the CONTRIBUTE explanation rather confusing to be honest, since it introduces ChangeLog files, mentions ChangeLog entries in that context (which I interpret as "one commit message -> one ChangeLog entry"), and then later talks about ChangeLog entries again, but in the context of the commit message (where I interpret it to mean "one ChangeLog entry = one file/function changed"). Only after reading this a few times in detail did I notice this distinction.
I've attached a patch with a proposed change in that section (I'll defer to others on fixing the numeric values as needed) that I feel is clearer. In particular, I merged two paragraphs that described when to add a descriptive paragraph to the commit message, and I used "file entry" to talk about what the previous version called "ChangeLog entries" in the second sense I mentioned above.
No worries if this doesn't get merged, or if people change my wording. I just thought it would be helpful to show an example of what I'd find clearer.
0001-CONTRIBUTE-Commit-messages-Improve-wording-about-fil.patch
Description: Text document
[Prev in Thread] | Current Thread | [Next in Thread] |