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 capitalized.
  42   * Not start with the package name.
  43   * Not have a period at the end.
  44 * `meta.license` must be set and fit the upstream license.
  45   * If there is no upstream license, `meta.license` should default to `lib.licenses.unfree`.
  46 * `meta.maintainers` must be set.
  47
  48 See the nixpkgs manual for more details on [standard meta-attributes](https://nixos.org/nixpkgs/manual/#sec-standard-meta-attributes).
  49
  50 ## Writing good commit messages
  51
  52 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.
  53
  54 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.
  55
  56 ## Rebasing between branches (i.e. from master to staging)
  57
  58 From time to time, changes between branches must be rebased, for example, if the
  59 number of new rebuilds they would cause is too large for the target branch. When
  60 rebasing, care must be taken to include only the intended changes, otherwise
  61 many CODEOWNERS will be inadvertently requested for review.  To achieve this,
  62 rebasing should not be performed directly on the target branch, but on the merge
  63 base between the current and target branch.
  64
  65 In the following example, we assume that the current branch, called `feature`,
  66 is based on `master`, and we rebase it onto the merge base between
  67 `master` and `staging` so that the PR can eventually be retargeted to
  68 `staging` without causing a mess. The example uses `upstream` as the remote for `NixOS/nixpkgs.git`
  69 while `origin` is the remote you are pushing to.
  70
  71
  72 ```console
  73 # Rebase your commits onto the common merge base
  74 git rebase --onto upstream/staging... upstream/master
  75 # Force push your changes
  76 git push origin feature --force-with-lease
  77 ```
  78
  79 The syntax `upstream/staging...` is equivalent to `upstream/staging...HEAD` and
  80 stands for the merge base between `upstream/staging` and `HEAD` (hence between
  81 `upstream/staging` and `upstream/master`).
  82
  83 Then change the base branch in the GitHub PR using the *Edit* button in the upper
  84 right corner, and switch from `master` to `staging`. *After* the PR has been
  85 retargeted it might be necessary to do a final rebase onto the target branch, to
  86 resolve any outstanding merge conflicts.
  87
  88 ```console
  89 # Rebase onto target branch
  90 git rebase upstream/staging
  91 # Review and fixup possible conflicts
  92 git status
  93 # Force push your changes
  94 git push origin feature --force-with-lease
  95 ```
  96
  97 ## Backporting changes
  98
  99 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).
 100
 101 You can add a label such as `backport release-22.05` to a PR, so that merging it will
 102 automatically create a backport (via [a GitHub Action](.github/workflows/backport.yml)).
 103 This also works for PR's that have already been merged, and might take a couple of minutes to trigger.
 104
 105 You can also create the backport manually:
 106
 107 1. Take note of the commits in which the change was introduced into `master` branch.
 108 2. Check out the target _release branch_, e.g. `release-22.05`. Do not use a _channel branch_ like `nixos-22.05` or `nixpkgs-22.05-darwin`.
 109 3. Create a branch for your change, e.g. `git checkout -b backport`.
 110 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.
 111 5. Push to GitHub and open a backport pull request. Make sure to select the release branch (e.g. `release-22.05`) 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. `[22.05]`.
 112 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.
 113
 114 ## Criteria for Backporting changes
 115
 116 Anything that does not cause user or downstream dependency regressions can be backported. This includes:
 117 - New Packages / Modules
 118 - Security / Patch updates
 119 - Version updates which include new functionality (but no breaking changes)
 120 - Services which require a client to be up-to-date regardless. (E.g. `spotify`, `steam`, or `discord`)
 121 - Security critical applications (E.g. `firefox`)
 122
 123 ## Generating 22.11 Release Notes
 124
 125 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.
 126
 127 Steps for updating 22.11 Release notes:
 128
 129 1. Edit `nixos/doc/manual/release-notes/rl-2211.section.md` with the desired changes
 130 2. Run `./nixos/doc/manual/md-to-db.sh` to render `nixos/doc/manual/from_md/release-notes/rl-2211.section.xml`
 131 3. Include changes to `rl-2211.section.md` and `rl-2211.section.xml` in the same commit.
 132
 133 ## Reviewing contributions
 134
 135 See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#chap-reviewing-contributions).