1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-12-09 02:21:05 +01: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.
This commit is contained in:
Robert Helgesson 2020-05-23 14:07:19 +02:00
parent 728c3eba67
commit c8b73e415a
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89
2 changed files with 108 additions and 29 deletions

View file

@ -1,16 +1,26 @@
### Description
<!--
Please fill the description and checklist to the best of your
ability.
Please provide a brief description of your change.
-->
### Description
### 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`.
@ -25,7 +35,7 @@
{long description}
```
See [CONTRIBUTING](https://github.com/rycee/home-manager/blob/master/doc/contributing.adoc#commits) for more information and [recent commit messages](https://github.com/rycee/home-manager/commits/master) for examples.
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