Mercurial > gbwm
view CONTRIBUTING.md @ 18:cecd3bd2d2a2
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 |
line wrap: on
line source
If gbwm ever gets contributors, here's a short memo with the rules: 1. Do not combine multiple unrelated changes in a single commit. If your commit touches several independent features or fixes and isn't logically atomic, split it. 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. 2. Use natural-language commit prefixes. Examples of valid prefixes: - feat, feature, featured — for small useful improvements - add, added — for new functionality - del, deleted, removed — for removed functionality - refactor, refactored — for code improvements that don't change behavior Good commit messages look like: ``` featured useful keybindings for laptop users XF86 keybindings fix added remembering for last focused window feat: moved config out of the main file ```