Add guidance on making commits atomic #696
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
It's really long, and uses H5 headings. Any new section would result in unreadable H6s.
chao-xian
force-pushed
the
commit-style
branch
2 times, most recently
from
3c2f684
to
0017f21
Compare
injms
reviewed
Mar 22, 2022
|
I think atomic commits are very useful, especially in how it helps makes reviewing clearer when stepping forwards and backwards through the commits whilst still having a (hopefully) working branch. I added a small suggestion to make the description of what an atomic commit is a bit clearer. |
For easier reading. Co-authored-by: Ian James <[email protected]>
injms
approved these changes
Mar 22, 2022
|
Thanks @injms! |
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.
Most developers are very good at making their commits granular/atomic. But it takes practise and isn't currently our recommended way. It should be something that we strive for.