Mercurial > gbwm

comparison CONTRIBUTING.md @ 18:cecd3bd2d2a2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added excludes for rule 1 in contributing guidelines
author Atarwn Gard <a@qwa.su>
date Wed, 15 Oct 2025 09:54:10 +0500
parents 5e9111d1a285
children 3f311009945a
comparison
equal deleted inserted replaced
17:7a779983be56 18:cecd3bd2d2a2
1 If gbwm ever gets contributors, here's a short memo with the rules: 1 If gbwm ever gets contributors, here's a short memo with the rules:
2 2
3 1. Do not combine multiple unrelated changes in a single commit. 3 1. Do not combine multiple unrelated changes in a single commit.
4 If your commit touches several independent features or fixes and isn't logically atomic, split it. 4 If your commit touches several independent features or fixes and isn't logically atomic, split it.
5
6 Minor related fixes—such as typos, formatting, preparatory refactoring tightly coupled to a new feature, or immediate bug fixes for issues introduced in the same PR—are acceptable in a single commit if they are logically cohesive and splitting them would reduce clarity or create broken intermediate states.
5 7
6 2. Use natural-language commit prefixes. 8 2. Use natural-language commit prefixes.
7 Examples of valid prefixes: 9 Examples of valid prefixes:
8 - feat, feature, featured — for small useful improvements 10 - feat, feature, featured — for small useful improvements
9 - add, added — for new functionality 11 - add, added — for new functionality