CONTRIBUTE: More formally specify the commit description #10478
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I don't think we need every instance of -by to be explained, we already know and state whatever-else-by: is an attribution. Some of the more common terms could be suggested on a single line like "Some common attribution terms are Reviewed-by, Signed-off-by, etc". Acked-by and tested-by aren't used like ever AFAICT. |
bagder
approved these changes
Feb 12, 2023
dfandrich
force-pushed
the
dfandrich/contrib
branch
from
1f0db2d
to
9c07c8e
Compare
|
Jay's suggestion makes the text considerably smaller and more approachable so I've done that. |
This codifies what people have actually used in git commits over the past 6 years. I've left off some lesser-used headers that appear to duplicate others and tried to describe a consistent use for several others that were used more arbitrarily. This makes it easier for new committers to find out the kinds of things we want to acknowledge, makes it easier to perform statistical analysis on commits, and opens the possibility of performing lint checks on descriptions before submission. Reviewed-by: Daniel Stenberg Reviewed-by: Jay Satiro Closes #10478
dfandrich
force-pushed
the
dfandrich/contrib
branch
from
9c07c8e
to
4357eea
Compare
bch
pushed a commit
to bch/curl
that referenced
this pull request
Jul 19, 2023
This codifies what people have actually used in git commits over the past 6 years. I've left off some lesser-used headers that appear to duplicate others and tried to describe a consistent use for several others that were used more arbitrarily. This makes it easier for new committers to find out the kinds of things we want to acknowledge, makes it easier to perform statistical analysis on commits, and opens the possibility of performing lint checks on descriptions before submission. Reviewed-by: Daniel Stenberg Reviewed-by: Jay Satiro Closes curl#10478
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This codifies what people have actually used in git commits over the
past 6 years. I've left off some lesser-used headers that appear to
duplicate others and tried to describe a consistent use for several
others that were used more arbitrarily.
This makes it easier for new committers to find out the kinds of things
we want to acknowledge, makes it easier to perform statistical analysis
on commits, and opens the possibility of performing lint checks on
descriptions before submission.
QUESTIONS:
The number of endorsed header types could be reduced and simplified, e.g.:
Endorsing them all does allow slightly more fine-grained information at the
price of slightly higher cognitive load reading them.