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

docs: cleanup CONTRIBUTING.md

Browse source
This commit is contained in:
seth 2024-01-11 17:03:38 -05:00
parent aeb0dcbf6a
commit 310ab70d9e
No known key found for this signature in database
GPG key ID: D31BD0D494BBEE86
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -2,15 +2,14 @@
## Adding a port ## Adding a port
Create a file in `modules/<module>/` with the name of the port. Add the file to the Create a file in `modules/<module>/` with the name of the port. All ports should have
`imports` declaration in `modules/<module>/default.nix`. All ports should have the the `catppuccin.enable` and `catppuccin.flavour` options, and optionally the
`catppuccin.enable` and `catppuccin.flavour` options, and optionally the
`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.
[nvfetcher](https://github.com/berberman/nvfetcher) is used to track our upstream [nvfetcher](https://github.com/berberman/nvfetcher) is used to track our upstream
sources to use in modules. This allows us to reduce [IFD](https://nixos.wiki/wiki/Import_From_Derivation) sources to use in modules. This allows us to easily access and auto-update all themes.
and auto-update all themes. Most repositories can be specified like so: Most repositories can be specified like so:
```toml ```toml
[program_name] [program_name]
@ -22,7 +21,7 @@ After creating your module, add the options to enable it in `test.nix` under the
`nodes.machine` attrset. This will allow for your configuration to be tested along `nodes.machine` attrset. This will allow for your configuration to be tested along
with the other modules in a VM automatically. with the other modules in a VM automatically.
<!-- This loooks the best with the changelog generator. --> <!-- This looks the best with the changelog generator. -->
Commits that add ports should be of the format Commits that add ports should be of the format
``` ```