docs: Add a summary of the git commit message rules #5283
Merged
Conversation
This file contains hidden or 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
bthomee
reviewed
Feb 11, 2025
CONTRIBUTING.md
Outdated
Comment on lines
111
to
121
| > 1. Separate subject from body with a blank line | ||
| > 2. Limit the subject line to 50 characters | ||
| > * [...]shoot for 50 characters, but consider 72 the hard limit. | ||
| > 3. Capitalize the subject line | ||
| > 4. Do not end the subject line with a period | ||
| > 5. Use the imperative mood in the subject line | ||
| > * A properly formed Git commit subject line should always be able | ||
| > to complete the following sentence: "If applied, this commit will | ||
| > _your subject line here_" | ||
| > 6. Wrap the body at 72 characters | ||
| > 7. Use the body to explain what and why vs. how |
There was a problem hiding this comment.
This is great and very helpful. Can you turn these bullet points into full sentences by having them end with a period? I'll happily approve afterwards.
There was a problem hiding this comment.
Yes, absolutely. I copied them from the original article (thus the >), but I am good with adding proper punctuation.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #5283 +/- ##
=======================================
Coverage 78.2% 78.2%
=======================================
Files 790 790
Lines 67638 67638
Branches 8164 8163 -1
=======================================
+ Hits 52860 52862 +2
+ Misses 14778 14776 -2 see 2 files with indirect coverage changes |
…ssages * upstream/develop: fix: Amendment to add transaction flag checking functionality for Credentials (5250) fix: Omit superfluous setCurrentThreadName call in GRPCServer.cpp (5280)
bthomee
approved these changes
Feb 11, 2025
This was referenced Feb 18, 2025
Closed
Closed
Closed
q73zhao
pushed a commit
that referenced
this pull request
Feb 24, 2025
This was referenced Feb 26, 2025
Closed
Merged
Closed
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.
High Level Overview of Change
Add a summary of the git commit message rules from the linked article, so they can be more quickly referenced and not necessarily require contributors to follow the link.
Context of Change
Make the expectations easier to find, and refer contributors toward.
I'm adding this to the 2.5.0 milestone, because there's no rush, but it would be ok to get it into 2.4.0.
Type of Change