Added some guides on commits in CONTRIUTING.md #381
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
Recently I found a nice guide on writing git commits, and I think we should encourage users to start writing git commits as an explanation for why changes were made.
This template includes some reference for how long each line should be. It comes from this Gist (modified to reduce length): https://gist.github.com/lisawolderiksen/a7b99d94c92c6671181611be1641c733
Explained how Git commits should justify the changes, and added some details on verbose commits and setting them up.
Co-authored-by: Patrick W. Crawford <theduckcow@live.com>
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.
No description provided.