Mercurial > gbwm
view CONTRIBUTING.md @ 21:3f311009945a default tip
mercurial is the main VCS
author | Atarwn Gard <a@qwa.su> |
---|---|
date | Wed, 15 Oct 2025 15:56:46 +0500 |
parents | cecd3bd2d2a2 |
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 ``` 3. Mercurial is the main VCS. The canonical repo is at https://hg.qwa.su/gbwm GitHub is a read-only mirror - do not send PRs. Submit changes as GPG signed patches (e.g. `hg export` output) to <a@qwa.su>. If you want push access to your own namespace on hg.qwa.su, include your public SSH key. You can find my GPG key on keyserver.ubuntu.com by this fingerprint: `5B60C1D1A8254465`