doc: move to doc directory (#1272)

This commit is contained in:
awwpotato 2025-05-20 02:26:52 -07:00 committed by GitHub
parent f8833c5e0c
commit fb9c22056f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
16 changed files with 5 additions and 5 deletions

View file

@ -1,31 +0,0 @@
# Commit convention
To keep things consistent, commit messages should follow a format
[similar to Nixpkgs](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#commit-conventions):
```
«scope»: «summary»
«motivation for change»
```
Where the scope is one of:
| Scope | Purpose |
|----------------|------------------------------------------------------------------|
| `ci` | Changes to GitHub Actions workflows. |
| `doc` | Changes to the website, `README.md`, and so on. |
| `flake` | Changes in the `flake` directory, `flake.nix`, and `flake.lock`. |
| `stylix` | Changes in the `stylix` directory and other global code. |
| Name of target | Changes to code for a particular target. |
| `treewide` | Changes across many targets. |
The scope is meant to indicate which area of the code was changed. Specifying
the type of change, such as `feat` or `fix`, is not necessary. Dependency
updates should use whichever scope they are related to.
The summary should start with a lowercase letter, and should not end with
punctuation.
Most commits to `master` will also include a pull request number in brackets
after the summary. GitHub adds this automatically when creating a squash merge.