Expand committing guidelines - #964
Merged
Merged
Conversation
jwaiton
requested changes
Oct 2, 2026
jwaiton
left a comment
jwaiton
left a comment
Member
There was a problem hiding this comment.
Good work! I've added some subjective comments, but think its pretty much ready to go.
The only thing missing is that this markdown page should be referenced in the main readme's documentation section. The whole doc folder should be, but I think certain files may need a revamp before that is deemed acceptable, and its beyond the scope of this PR :)
which also refers to the committing guidelines
gonzaponte
force-pushed
the
doc-commits
branch
from
October 2, 2026 14:46
2a48be1 to
715bc01
Compare
jwaiton
approved these changes
Oct 2, 2026
jwaiton
left a comment
jwaiton
left a comment
Member
There was a problem hiding this comment.
This PR improves the commit guidelines to be more approachable and easy to find within the IC repository.
Great work, approved!
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 PR adds some more detailed documentation on how to build a good commit history. Specifically, it adds some good and bad examples based on user experience.