chore: update commit guidelines in CONTRIBUTING.md #5648
Merged
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #5648 +/- ##
=======================================
Coverage 59.49% 59.49%
=======================================
Files 346 346
Lines 29371 29371
=======================================
Hits 17474 17474
Misses 10922 10922
Partials 975 975 |
The commit guidelines are too vague and offer little guidance on acceptable commit styles. This patch expands on what is acceptable with some examples of what a commit is supposed to look like. Signed-off-by: Alano Terblanche <[email protected]> Co-authored-by: Christopher Petito <[email protected]>
Benehiko
force-pushed
the
improve-contribution
branch
from
b8208de to
4a219b1
Compare
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.
- What I did
The commit guidelines are too vague and offer little guidance on
acceptable commit styles. This patch expands on what is acceptable
with some examples of what a commit is supposed to look like.
- How I did it
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)