eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-12-25 19:29:47 +01:00
Code Issues Releases Wiki Activity
home-manager/.github/PULL_REQUEST_TEMPLATE.md

45 lines
1.2 KiB
Markdown
Raw Normal View History

doc: add contribution guidelines section 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.
2020-05-23 14:07:19 +02:00
### Description
Add code owners and pull request template
2020-04-08 19:22:36 +02:00
<!--
doc: add contribution guidelines section 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.
2020-05-23 14:07:19 +02:00
Please provide a brief description of your change.
Add code owners and pull request template
2020-04-08 19:22:36 +02:00
-->
doc: add contribution guidelines section 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.
2020-05-23 14:07:19 +02:00
### Checklist
<!--
Add code owners and pull request template
2020-04-08 19:22:36 +02:00
doc: add contribution guidelines section 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.
2020-05-23 14:07:19 +02:00
Please go through the following checklist before opening a non-WIP
pull-request.
Add code owners and pull request template
2020-04-08 19:22:36 +02:00
doc: add contribution guidelines section 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.
2020-05-23 14:07:19 +02:00
Also make sure to read the guidelines found at
Add code owners and pull request template
2020-04-08 19:22:36 +02:00
doc: add contribution guidelines section 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.
2020-05-23 14:07:19 +02:00
https://github.com/rycee/home-manager/blob/master/doc/contributing.adoc#sec-guidelines
-->
- [ ] Change is backwards compatible.
Add code owners and pull request template
2020-04-08 19:22:36 +02:00
- [ ] 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}
```
doc: add contribution guidelines section 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.
2020-05-23 14:07:19 +02:00
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.
Add code owners and pull request template
2020-04-08 19:22:36 +02:00
- 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`.
Reference in a new issue Copy permalink