CONTRIBUTING.md

   1 # How to contribute
   2
   3 Note: contributing implies licensing those contributions
   4 under the terms of [COPYING](../COPYING), which is an MIT-like license.
   5
   6 ## Opening issues
   7
   8 * Make sure you have a [GitHub account](https://github.com/signup/free)
   9 * Make sure there is no open issue on the topic
  10 * [Submit a new issue](https://github.com/NixOS/nixpkgs/issues/new/choose) by choosing the kind of topic and fill out the template
  11
  12 ## Submitting changes
  13
  14 * Format the commit messages in the following way:
  15
  16   ```
  17   (pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc)
  18
  19   (Motivation for change. Additional information.)
  20   ```
  21
  22   For consistency, there should not be a period at the end of the commit message's summary line (the first line of the commit message).
  23
  24   Examples:
  25
  26   * nginx: init at 2.0.1
  27   * firefox: 54.0.1 -> 55.0
  28   * nixos/hydra: add bazBaz option
  29
  30     Dual baz behavior is needed to do foo.
  31   * nixos/nginx: refactor config generation
  32
  33     The old config generation system used impure shell scripts and could break in specific circumstances (see #1234).
  34
  35 * `meta.description` should:
  36   * Be capitalized.
  37   * Not start with the package name.
  38   * Not have a period at the end.
  39 * `meta.license` must be set and fit the upstream license.
  40   * If there is no upstream license, `meta.license` should default to `lib.licenses.unfree`.
  41 * `meta.maintainers` must be set.
  42
  43 See the nixpkgs manual for more details on [standard meta-attributes](https://nixos.org/nixpkgs/manual/#sec-standard-meta-attributes) and on how to [submit changes to nixpkgs](https://nixos.org/nixpkgs/manual/#chap-submitting-changes).
  44
  45 ## Writing good commit messages
  46
  47 In addition to writing properly formatted commit messages, it's important to include relevant information so other developers can later understand *why* a change was made. While this information usually can be found by digging code, mailing list/Discourse archives, pull request discussions or upstream changes, it may require a lot of work.
  48
  49 For package version upgrades and such a one-line commit message is usually sufficient.
  50
  51 ## Backporting changes
  52
  53 Follow these steps to backport a change into a release branch in compliance with the [commit policy](https://nixos.org/nixpkgs/manual/#submitting-changes-stable-release-branches).
  54
  55 1. Take note of the commits in which the change was introduced into `master` branch.
  56 2. Check out the target _release branch_, e.g. `release-20.09`. Do not use a _channel branch_ like `nixos-20.09` or `nixpkgs-20.09`.
  57 3. Create a branch for your change, e.g. `git checkout -b backport`.
  58 4. When the reason to backport is not obvious from the original commit message, use `git cherry-pick -xe <original commit>` and add a reason. Otherwise use `git cherry-pick -x <original commit>`. That's fine for minor version updates that only include security and bug fixes, commits that fixes an otherwise broken package or similar. Please also ensure the commits exists on the master branch; in the case of squashed or rebased merges, the commit hash will change and the new commits can be found in the merge message at the bottom of the master pull request.
  59 5. Push to GitHub and open a backport pull request. Make sure to select the release branch (e.g. `release-20.09`) as the target branch of the pull request, and link to the pull request in which the original change was comitted to `master`. The pull request title should be the commit title with the release version as prefix, e.g. `[20.09]`.
  60 6. When the backport pull request is merged and you have the necessary privileges you can also replace the label `9.needs: port to stable` with `8.has: port to stable` on the original pull request. This way maintainers can keep track of missing backports easier.
  61
  62 ## Criteria for Backporting changes
  63
  64 Anything that does not cause user or downstream dependency regressions can be backported. This includes:
  65 - New Packages / Modules
  66 - Security / Patch updates
  67 - Version updates which include new functionality (but no breaking changes)
  68 - Services which require a client to be up-to-date regardless. (E.g. `spotify`, `steam`, or `discord`)
  69 - Security critical applications (E.g. `firefox`)
  70
  71 ## Generating 21.11 Release Notes
  72
  73 (This section also applies to backporting 21.05 release notes: substitute "rl-2111" for "rl-2105".)
  74
  75 Documentation in nixpkgs is transitioning to a markdown-centric workflow. Release notes now require a translation step to convert from markdown to a compatible docbook document.
  76
  77 Steps for updating 21.11 Release notes:
  78
  79 1. Edit `nixos/doc/manual/release-notes/rl-2111.section.md` with the desired changes
  80 2. Run `./nixos/doc/manual/md-to-db.sh` to render `nixos/doc/manual/from_md/release-notes/rl-2111.section.xml`
  81 3. Include changes to `rl-2111.section.md` and `rl-2111.section.xml` in the same commit.
  82
  83 ## Reviewing contributions
  84
  85 See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#chap-reviewing-contributions).