Re: Git commit message RFC
On 08/01/20 00:19, Artem Shchygel wrote:
Hi, AllHints are very welcome, but not in subject lines. Please use
Name: value # comment
style tags near the end of the commit messages instead.
Subject lines are primarily for human readers. And because edk2 has long
filenames, and we're supposed to include package names and component
names in subject lines, hardly any space is left for actual meaningful
subjects. CVE identifiers are the only exceptions (they *should* be
mentioned in subjects lines; and PatchCheck.py already permits more
characters in subjects that contain CVE identifiers).
2. Remove "Package/Module" reference from subject line. Since subject line length is limited it's better to be allocated for commit description which is more importantI'm opposed to this. "Package/Module" is the absolute key by which I
orient myself for determining impact / maintainership relevance /
regression risk. I regularly browse the git history for new commits, and
I entirely orient myself after the Package/Module prefixes.
3. Remove "CVE" number from subject line for the same reason. CVE number (if present) should be placed on separate line after long description (see example below)I agree that mentioning CVE IDs in subject lines is an exceptions. I
could let go of that, if contributors were *very* disciplined about
stating CVE IDs properly in commit messages.
4. Add optional tag to the long description. List of tags is as follows:Explicitly stating such traits is very welcome (even if not with this
specific format, perhaps) in commit message bodies.
Bugzilla numbers should already be stated as:
I entirely support including as much information as possible in commit
messages; if we can do that in machine readable format, that's even
better. But subject lines are not the place; the commit message bodies are.
I recommend the "Name: value" and "Name: value # comment" formats, but
don't insist on those.
What really matters to me is that we don't litter subject lines with
Obviously: this is just my personal opinion.