punkfairie/rose-pine-nix
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: clean up contributing guidelines

Browse source 
Add `modules` to commit scopes and provide guidelines for commits that add ports.
This commit is contained in:
Sam Nystrom 2023-04-15 08:47:09 -04:00 committed by GitHub
parent 38fa66cba9
commit 006690349a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -8,11 +8,14 @@ Create a file in `modules/<module>/` with the name of the port. Add the file to
`catppuccin.accent` option. `catppuccin.flavour` and `catppuccin.accent` should `catppuccin.accent` option. `catppuccin.flavour` and `catppuccin.accent` should
default to `config.catppuccin.flavour` and `config.catppuccin.accent`, respectively. default to `config.catppuccin.flavour` and `config.catppuccin.accent`, respectively.
<!-- This loooks the best with the changelog generator. -->
Commits that add ports should be of the format `feat(modules): add support for <port>`.
## Commit messages ## Commit messages
This repository uses [Conventional Commits](https://conventionalcommits.org). This repository uses [Conventional Commits](https://conventionalcommits.org).
All commits should include a body that briefly describes the motivation and content Commit headers should be lowercase. Most commits should include a body that briefly
of the commit. describes the motivation and content of the commit.
### Commit types ### Commit types
@ -29,8 +32,8 @@ of the commit.
### Commit scopes ### Commit scopes
For the commit scope, put the name of the port the commit affects. If the commit Available commit scopes are port names and `modules`. If neither of these apply,
does not affect a specific port, omit the scope. omit the scope.
### Breaking changes ### Breaking changes