diff options
| author | zimbatm <zimbatm@zimbatm.com> | 2016-04-09 17:53:24 +0100 |
|---|---|---|
| committer | zimbatm <zimbatm@zimbatm.com> | 2016-04-09 17:59:35 +0100 |
| commit | 8706726d59ba80ebe9ad7c4c68fa52defdc10924 (patch) | |
| tree | fe2e8173241df9122ff7ef703e7856000dfb509a /.github | |
| parent | ff52ac75f6c989b522df77a6c3c81a24b159d9ff (diff) | |
Simplify contributing
* Highlight the top mistakes directly in CONTRIBUTING.md
* Remove unecessary cruft from the PR template
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 16 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 10 |
2 files changed, 16 insertions, 10 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0ddf93dbec4f..9a7a55f8676f 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -12,4 +12,18 @@ under the terms of [COPYING](../COPYING), which is an MIT-like license. ## Submitting changes -See the nixpkgs manual for details on how to [Submit changes to nixpkgs](http://hydra.nixos.org/job/nixpkgs/trunk/manual/latest/download-by-type/doc/manual#chap-submitting-changes). +* Format the commits in the following way: + + `(pkg-name | service-name): (from -> to | init at version | refactor | etc)` + + Examples: + + * nginx: init at 2.0.1 + * firefox: 3.0 -> 3.1.1 + * hydra service: add bazBaz option + * nginx service: refactor config generation + +* Don't put dots at the end of package descriptions. + +See the nixpkgs manual for more details on how to [Submit changes to nixpkgs](http://hydra.nixos.org/job/nixpkgs/trunk/manual/latest/download-by-type/doc/manual#chap-submitting-changes). + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index aac1650ae7ae..ceea615d5d7f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -###### Things done: +###### Things done - [ ] Tested using sandboxing (`nix-build --option build-use-chroot true` or [nix.useChroot](http://nixos.org/nixos/manual/options.html#opt-nix.useChroot) on NixOS) - Built on platform(s) @@ -9,13 +9,5 @@ - [ ] Tested execution of all binary files (usually in `./result/bin/`) - [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md). -###### More - -Fixes issue #<insert id> - -cc @<maintainer> - - --- -_Please note, that points are not mandatory, but rather desired._ |