Mercurial > gbwm

comparison CONTRIBUTING.md @ 16:5e9111d1a285

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added contribution guidelines
author Atarwn Gard <a@qwa.su>
date Wed, 15 Oct 2025 08:40:10 +0500
parents
children cecd3bd2d2a2
comparison
equal deleted inserted replaced
15:9d6b34ed3a09 16:5e9111d1a285
1 If gbwm ever gets contributors, here's a short memo with the rules:
2
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.
5
6 2. Use natural-language commit prefixes.
7 Examples of valid prefixes:
8 - feat, feature, featured — for small useful improvements
9 - add, added — for new functionality
10 - del, deleted, removed — for removed functionality
11 - refactor, refactored — for code improvements that don't change behavior
12
13 Good commit messages look like:
14 ```
15 featured useful keybindings for laptop users
16 XF86 keybindings fix
17 added remembering for last focused window
18 feat: moved config out of the main file
19 ```