Mercurial > gbwm

annotate CONTRIBUTING.md @ 19:71d1633609d5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
change window closing and quit keys because you can misclick Mod+a with Mod+q (feat)
author Atarwn Gard <a@qwa.su>
date Wed, 15 Oct 2025 10:38:24 +0500
parents cecd3bd2d2a2
children 3f311009945a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
1 If gbwm ever gets contributors, here's a short memo with the rules:
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
2
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
3 1. Do not combine multiple unrelated changes in a single commit.
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
4 If your commit touches several independent features or fixes and isn't logically atomic, split it.
18
cecd3bd2d2a2 added excludes for rule 1 in contributing guidelines
Atarwn Gard <a@qwa.su>
parents: 16
diff changeset
5
cecd3bd2d2a2 added excludes for rule 1 in contributing guidelines
Atarwn Gard <a@qwa.su>
parents: 16
diff changeset
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.
16
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
7
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
8 2. Use natural-language commit prefixes.
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
9 Examples of valid prefixes:
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
10 - feat, feature, featured — for small useful improvements
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
11 - add, added — for new functionality
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
12 - del, deleted, removed — for removed functionality
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
13 - refactor, refactored — for code improvements that don't change behavior
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
14
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
15 Good commit messages look like:
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
16 ```
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
17 featured useful keybindings for laptop users
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
18 XF86 keybindings fix
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
19 added remembering for last focused window
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
20 feat: moved config out of the main file
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
21 ```