diff options
| author | Robert Helgesson <robert@rycee.net> | 2020-05-23 14:07:19 +0200 |
|---|---|---|
| committer | Robert Helgesson <robert@rycee.net> | 2020-05-29 21:43:40 +0200 |
| commit | c8b73e415a1b3a080b636d13dfaae40b8b3147c6 (patch) | |
| tree | 9ee3f88d2fe96004bb0086bf6eecfe829549f3ea /.github | |
| parent | 728c3eba67efd733c4bcfc8ba40162191b7e128f (diff) | |
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.
Diffstat (limited to '.github')
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f60d5ee8970..eb6eca76250 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,25 @@ +### 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 -### Checklist + https://github.com/rycee/home-manager/blob/master/doc/contributing.adoc#sec-guidelines + +--> + +- [ ] Change is backwards compatible. - [ ] Code formatted with `./format`. @@ -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 |