Add commit standards #14
Open
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
franmoore05
reviewed
Feb 4, 2025
| A good commit message briefly summarises the "what" for scanning purposes, but also includes the "why". If the "what" in the message is not enough, the diff is there as a fallback. This is not true for the "why" of a change - this can be much harder or impossible to reconstruct, but is often of great significance. | ||
|
|
||
| ## Merging and squashing | ||
|
|
There was a problem hiding this comment.
Would it also be useful to add a command line example of how this should be done here?
There was a problem hiding this comment.
is that on how to commit? or how to squash? or how to squash merge?
MebinAbraham
previously approved these changes
Feb 4, 2025
MebinAbraham
previously approved these changes
Feb 5, 2025
franmoore05
approved these changes
Feb 6, 2025
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
Added commit standards - whilst we do follow GDS way, and it is important re-write content for the sake of it, I thought it important to have some of their copy in our standards to ensure they are read. Have also added some commentary around rebasing / merge commits etc. to reflect current practices.
How to review
Check reads ok and follows current standards.
Who can review
Tech leads.