repository: update commit format, migrate to markdown
This commit is contained in:
parent
07216e2fa3
commit
0ba532c44a
2 changed files with 36 additions and 119 deletions
36
repository.md
Normal file
36
repository.md
Normal file
|
@ -0,0 +1,36 @@
|
|||
# Repository Notes
|
||||
|
||||
> **Note**
|
||||
> These are a set of loose guidelines, that I am using as a reminder/general format for myself.
|
||||
|
||||
## Commit Message Format
|
||||
|
||||
```
|
||||
[location/scope]: [subject]
|
||||
|
||||
[body]
|
||||
|
||||
[footer]
|
||||
```
|
||||
|
||||
### Locations
|
||||
|
||||
The location in a commit message represents where the change affects.
|
||||
|
||||
- A host (`Infini-DESKTOP`, etc.)
|
||||
- A module (Just use the module name, not including `module` or `functionality` as a prefix, to reduce length)
|
||||
- A profile
|
||||
- `pkgs`
|
||||
- `overlays`
|
||||
- Etc.
|
||||
|
||||
If affecting multiple locations, separate with a comma.
|
||||
If affecting all, use a `*`, like `hosts/*`.
|
||||
If in a sub-location, separate with a slash, such as `overlays/patches`.
|
||||
|
||||
### Scopes
|
||||
|
||||
A scope is an abstract type of location, such as:
|
||||
|
||||
- `flake` for `flake.nix` or a flake-wide change
|
||||
- `bump` for `flake.lock` updates
|
Loading…
Add table
Add a link
Reference in a new issue