From 8706726d59ba80ebe9ad7c4c68fa52defdc10924 Mon Sep 17 00:00:00 2001 From: zimbatm Date: Sat, 9 Apr 2016 17:53:24 +0100 Subject: Simplify contributing * Highlight the top mistakes directly in CONTRIBUTING.md * Remove unecessary cruft from the PR template --- .github/CONTRIBUTING.md | 16 +++++++++++++++- .github/PULL_REQUEST_TEMPLATE.md | 10 +--------- 2 files changed, 16 insertions(+), 10 deletions(-) (limited to '.github') 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 # - -cc @ - - --- -_Please note, that points are not mandatory, but rather desired._ -- cgit v1.2.3