Add documentation on how to prepare commits #701
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
jacg
reviewed
Mar 6, 2020
doc/commits.rst
Outdated
| For instance, do not mix cosmetical changes with other, more relevant ones. | ||
|
|
||
| - Commit frequently and in an incremental manner. | ||
| Do not be afraid of making too many commits, they can be merged afterwards. |
There was a problem hiding this comment.
Careful, "merge" has a very specific meaning in git, and not the one you are trying to convey here: "squash".
There was a problem hiding this comment.
Yup, you are right. I was actually thinking that maybe it would be more descriptive for people that are not familiar with git, but it cannot be used like this.
There was a problem hiding this comment.
I understand completely where you're coming from. How about: "they can be combined afterwards. (This is known as squashing in git.)"?
There was a problem hiding this comment.
Yes, that's nice.
gonzaponte
force-pushed
the
docs.commit-guide
branch
from
25caee2 to
a7d11eb
Compare
gonzaponte
changed the title
gonzaponte
force-pushed
the
docs.commit-guide
branch
2 times, most recently
from
c9bcf77 to
1b831b6
Compare
mmkekic
approved these changes
Apr 10, 2020
gonzaponte
force-pushed
the
docs.commit-guide
branch
from
1b831b6 to
8d2c931
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.
This is a first attempt in documenting how to make a good commit, building on what's already described in
contributing.rstand making it a bit more specific.I intend to update this PR with some common practices that don't follow these guidelines to make a clearer picture.