annotate CONTRIBUTING.md @ 16:5e9111d1a285

added contribution guidelines
author Atarwn Gard <a@qwa.su>
date Wed, 15 Oct 2025 08:40:10 +0500
parents
children cecd3bd2d2a2
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.
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
5
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
6 2. Use natural-language commit prefixes.
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
7 Examples of valid prefixes:
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
8 - feat, feature, featured — for small useful improvements
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
9 - add, added — for new functionality
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
10 - del, deleted, removed — for removed functionality
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
11 - refactor, refactored — for code improvements that don't change behavior
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
12
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
13 Good commit messages look like:
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 featured useful keybindings for laptop users
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
16 XF86 keybindings fix
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
17 added remembering for last focused window
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
18 feat: moved config out of the main file
5e9111d1a285 added contribution guidelines
Atarwn Gard <a@qwa.su>
parents:
diff changeset
19 ```