philipp
/
nixpkgs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
nixpkgs/.github/CONTRIBUTING.md

30 lines
1.0 KiB
Markdown
Raw Normal View History

CONTRIBUTING.md: initial
2015-04-07 15:11:59 +02:00
# How to contribute
CONTRIBUTING.md: add a notice about licensing This suplements changes from #11557; see the long discussion.
2015-12-19 14:34:58 +01:00
Note: contributing implies licensing those contributions
CONTRIBUTING.md: Fix link to COPYING
2016-02-23 14:47:43 +01:00
under the terms of [COPYING](../COPYING), which is an MIT-like license.
CONTRIBUTING.md: add a notice about licensing This suplements changes from #11557; see the long discussion.
2015-12-19 14:34:58 +01:00
CONTRIBUTING.md: initial
2015-04-07 15:11:59 +02:00
## Opening issues
* Make sure you have a [GitHub account](https://github.com/signup/free)
CONTRIBUTING.md: fix typos
2015-06-21 17:32:54 +02:00
* [Submit an issue](https://github.com/NixOS/nixpkgs/issues) - assuming one does not already exist.
* Clearly describe the issue including steps to reproduce when it is a bug.
* Include information what version of nixpkgs and Nix are you using (nixos-version or git revision).
CONTRIBUTING.md: initial
2015-04-07 15:11:59 +02:00
## Submitting changes
Simplify contributing * Highlight the top mistakes directly in CONTRIBUTING.md * Remove unecessary cruft from the PR template
2016-04-09 18:53:24 +02:00
* 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).