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 Read the ["Submitting changes"](https://nixos.org/nixpkgs/manual/#chap-submitting-changes) section of the nixpkgs manual. It explains how to write, test, and iterate on your change, and which branch to base your pull request against.
  15
  16 Below is a short excerpt of some points in there:
  17
  18 * Format the commit messages in the following way:
  19
  20   ```
  21   (pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc)
  22
  23   (Motivation for change. Link to release notes. Additional information.)
  24   ```
  25
  26   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).
  27
  28   Examples:
  29
  30   * nginx: init at 2.0.1
  31   * firefox: 54.0.1 -> 55.0
  32     https://www.mozilla.org/en-US/firefox/55.0/releasenotes/
  33   * nixos/hydra: add bazBaz option
  34
  35     Dual baz behavior is needed to do foo.
  36   * nixos/nginx: refactor config generation
  37
  38     The old config generation system used impure shell scripts and could break in specific circumstances (see #1234).
  39
  40 * `meta.description` should:
  41   * Be short, just one sentence.
  42   * Be capitalized.
  43   * Not start with the package name.
  44     * More generally, it should not refer to the package name.
  45   * Not end with a period (or any punctuation for that matter).
  46   * Aim to inform while avoiding subjective language.
  47 * `meta.license` must be set and fit the upstream license.
  48   * If there is no upstream license, `meta.license` should default to `lib.licenses.unfree`.
  49   * If in doubt, try to contact the upstream developers for clarification.
  50 * `meta.maintainers` must be set.
  51
  52 See the nixpkgs manual for more details on [standard meta-attributes](https://nixos.org/nixpkgs/manual/#sec-standard-meta-attributes).
  53
  54 ## Writing good commit messages
  55
  56 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.
  57
  58 Package version upgrades usually allow for simpler commit messages, including attribute name, old and new version, as well as a reference to the relevant release notes/changelog. Every once in a while a package upgrade requires more extensive changes, and that subsequently warrants a more verbose message.
  59
  60 Pull requests should not be squash merged in order to keep complete commit messages and GPG signatures intact and must not be when the change doesn't make sense as a single commit.
  61 This means that, when addressing review comments in order to keep the pull request in an always mergeable status, you will sometimes need to rewrite your branch's history and then force-push it with `git push --force-with-lease`.
  62 Useful git commands that can help a lot with this are `git commit --patch --amend` and `git rebase --interactive`. For more details consult the git man pages or online resources like [git-rebase.io](https://git-rebase.io/) or [The Pro Git Book](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History).
  63
  64 ## Testing changes
  65
  66 To run the main types of tests locally:
  67
  68 - Run package-internal tests with `nix-build --attr pkgs.PACKAGE.passthru.tests`
  69 - Run [NixOS tests](https://nixos.org/manual/nixos/unstable/#sec-nixos-tests) with `nix-build --attr nixosTest.NAME`, where `NAME` is the name of the test listed in `nixos/tests/all-tests.nix`
  70 - Run [global package tests](https://nixos.org/manual/nixpkgs/unstable/#sec-package-tests) with `nix-build --attr tests.PACKAGE`, where `PACKAGE` is the name of the test listed in `pkgs/test/default.nix`
  71 - See `lib/tests/NAME.nix` for instructions on running specific library tests
  72
  73 ## Rebasing between branches (i.e. from master to staging)
  74
  75 From time to time, changes between branches must be rebased, for example, if the
  76 number of new rebuilds they would cause is too large for the target branch. When
  77 rebasing, care must be taken to include only the intended changes, otherwise
  78 many CODEOWNERS will be inadvertently requested for review. To achieve this,
  79 rebasing should not be performed directly on the target branch, but on the merge
  80 base between the current and target branch. As an additional precautionary measure,
  81 you should temporarily mark the PR as draft for the duration of the operation.
  82 This reduces the probability of mass-pinging people. (OfBorg might still
  83 request a couple of persons for reviews though.)
  84
  85 In the following example, we assume that the current branch, called `feature`,
  86 is based on `master`, and we rebase it onto the merge base between
  87 `master` and `staging` so that the PR can eventually be retargeted to
  88 `staging` without causing a mess. The example uses `upstream` as the remote for `NixOS/nixpkgs.git`
  89 while `origin` is the remote you are pushing to.
  90
  91
  92 ```console
  93 # Rebase your commits onto the common merge base
  94 git rebase --onto upstream/staging... upstream/master
  95 # Force push your changes
  96 git push origin feature --force-with-lease
  97 ```
  98
  99 The syntax `upstream/staging...` is equivalent to `upstream/staging...HEAD` and
 100 stands for the merge base between `upstream/staging` and `HEAD` (hence between
 101 `upstream/staging` and `upstream/master`).
 102
 103 Then change the base branch in the GitHub PR using the *Edit* button in the upper
 104 right corner, and switch from `master` to `staging`. *After* the PR has been
 105 retargeted it might be necessary to do a final rebase onto the target branch, to
 106 resolve any outstanding merge conflicts.
 107
 108 ```console
 109 # Rebase onto target branch
 110 git rebase upstream/staging
 111 # Review and fixup possible conflicts
 112 git status
 113 # Force push your changes
 114 git push origin feature --force-with-lease
 115 ```
 116
 117 ### Something went wrong and a lot of people were pinged
 118
 119 It happens. Remember to be kind, especially to new contributors.
 120 There is no way back, so the pull request should be closed and locked
 121 (if possible). The changes should be re-submitted in a new PR, in which the people
 122 originally involved in the conversation need to manually be pinged again.
 123 No further discussion should happen on the original PR, as a lot of people
 124 are now subscribed to it.
 125
 126 The following message (or a version thereof) might be left when closing to
 127 describe the situation, since closing and locking without any explanation
 128 is kind of rude:
 129
 130 ```markdown
 131 It looks like you accidentally mass-pinged a bunch of people, which are now subscribed
 132 and getting notifications for everything in this pull request. Unfortunately, they
 133 cannot be automatically unsubscribed from the issue (removing review request does not
 134 unsubscribe), therefore development cannot continue in this pull request anymore.
 135
 136 Please open a new pull request with your changes, link back to this one and ping the
 137 people actually involved in here over there.
 138
 139 In order to avoid this in the future, there are instructions for how to properly
 140 rebase between branches in our [contribution guidelines](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#rebasing-between-branches-ie-from-master-to-staging).
 141 Setting your pull request to draft prior to rebasing is strongly recommended.
 142 In draft status, you can preview the list of people that are about to be requested
 143 for review, which allows you to sidestep this issue.
 144 This is not a bulletproof method though, as OfBorg still does review requests even on draft PRs.
 145 ```
 146
 147 ## Backporting changes
 148
 149 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).
 150
 151 You can add a label such as `backport release-23.05` to a PR, so that merging it will
 152 automatically create a backport (via [a GitHub Action](.github/workflows/backport.yml)).
 153 This also works for pull requests that have already been merged, and might take a couple of minutes to trigger.
 154
 155 You can also create the backport manually:
 156
 157 1. Take note of the commits in which the change was introduced into `master` branch.
 158 2. Check out the target _release branch_, e.g. `release-23.05`. Do not use a _channel branch_ like `nixos-23.05` or `nixpkgs-23.05-darwin`.
 159 3. Create a branch for your change, e.g. `git checkout -b backport`.
 160 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.
 161 5. Push to GitHub and open a backport pull request. Make sure to select the release branch (e.g. `release-23.05`) as the target branch of the pull request, and link to the pull request in which the original change was committed to `master`. The pull request title should be the commit title with the release version as prefix, e.g. `[23.05]`.
 162 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.
 163
 164 ## Criteria for Backporting changes
 165
 166 Anything that does not cause user or downstream dependency regressions can be backported. This includes:
 167 - New Packages / Modules
 168 - Security / Patch updates
 169 - Version updates which include new functionality (but no breaking changes)
 170 - Services which require a client to be up-to-date regardless. (E.g. `spotify`, `steam`, or `discord`)
 171 - Security critical applications (E.g. `firefox`)
 172
 173 ## Reviewing contributions
 174
 175 See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#chap-reviewing-contributions).