nixpkgs-suyu/.github/CONTRIBUTING.md
zimbatm 8706726d59 Simplify contributing
* Highlight the top mistakes directly in CONTRIBUTING.md
* Remove unecessary cruft from the PR template
2016-04-09 17:59:35 +01:00

1 KiB

How to contribute

Note: contributing implies licensing those contributions under the terms of COPYING, which is an MIT-like license.

Opening issues

  • Make sure you have a GitHub account
  • Submit an issue - 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).

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.