nixpkgs/.github/CONTRIBUTING.md
zimbatm 0e3e7a6bcd Merge pull request #18972 from ericsagnes/doc/reviewing-contributions
[WIP] nixos-doc: add reviewing contributions chapter
2016-10-01 15:09:12 +01:00

1.3 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
  • meta.description should:

    • Be capitalized
    • Not start with the package name
    • Not have a dot at the end

See the nixpkgs manual for more details on how to Submit changes to nixpkgs.

Reviewing contributions

See the nixpkgs manual for more details on how to Review contributions.