docs: Add commit structuring guidelines to CONTRIBUTING.md #4421
+12
−0
Conversation
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
mkleczek
force-pushed
the
add-pr-structure-to-contributing
branch
from
0488243 to
7e83e47
Compare
Added guidelines for structuring commits in pull requests to maintain a clean history and facilitate reviews.
mkleczek
force-pushed
the
add-pr-structure-to-contributing
branch
from
7e83e47 to
9c25a41
Compare
| * All commits in the source branch must be self contained, meaning: it should be possible to treat each commit as a separate PR. | ||
| * Commits in the source branch must contain only related changes (related means the changes target a single problem/goal). For example, any refactorings should be isolated from the actual change implementation into separate commits. | ||
| * Tests, documentation, and changelog updates should be contained in the same commits as the actual code changes they relate to. An exception to this rule is when test or documentation changes are made in separate PR. | ||
| * Commit messages must be prefixed with one of the following prefixes: `fix: `, `test: `, `docs: `, `perf: `, `refactor: `. |
There was a problem hiding this comment.
Maybe link to this list instead:
postgrest/nix/tools/gitTools.nix
Lines 12 to 23 in 3db0561
the above is validated with commitlint
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.
Added guidelines for structuring commits in pull requests to maintain a clean history and facilitate reviews.