c8b73e415a
This adds a section in the documentation for describing a list of guidelines that code in Home Manager should follow. This also updates the pull request template to reference this new section.
45 lines
1.2 KiB
Markdown
45 lines
1.2 KiB
Markdown
### Description
|
|
|
|
<!--
|
|
|
|
Please provide a brief description of your change.
|
|
|
|
-->
|
|
|
|
### Checklist
|
|
|
|
<!--
|
|
|
|
Please go through the following checklist before opening a non-WIP
|
|
pull-request.
|
|
|
|
Also make sure to read the guidelines found at
|
|
|
|
https://github.com/rycee/home-manager/blob/master/doc/contributing.adoc#sec-guidelines
|
|
|
|
-->
|
|
|
|
- [ ] Change is backwards compatible.
|
|
|
|
- [ ] Code formatted with `./format`.
|
|
|
|
- [ ] Code tested through `nix-shell --pure tests -A run.all`.
|
|
|
|
- [ ] Test cases updated/added. See [example](https://github.com/rycee/home-manager/commit/f3fbb50b68df20da47f9b0def5607857fcc0d021#diff-b61a6d542f9036550ba9c401c80f00ef).
|
|
|
|
- [ ] Commit messages are formatted like
|
|
|
|
```
|
|
{component}: {description}
|
|
|
|
{long description}
|
|
```
|
|
|
|
See [CONTRIBUTING](https://github.com/rycee/home-manager/blob/master/doc/contributing.adoc#sec-commit-style) for more information and [recent commit messages](https://github.com/rycee/home-manager/commits/master) for examples.
|
|
|
|
- If this PR adds a new module
|
|
|
|
- [ ] Added myself as module maintainer. See [example](https://github.com/rycee/home-manager/blob/068ff76a10e95820f886ac46957edcff4e44621d/modules/programs/lesspipe.nix#L6).
|
|
|
|
- [ ] Added myself and the module files to `.github/CODEOWNERS`.
|