You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
136 lines
7.0 KiB
136 lines
7.0 KiB
9 years ago
|
# How to contribute
|
||
|
|
||
9 years ago
|
Note: contributing implies licensing those contributions
|
||
3 years ago
|
under the terms of [COPYING](COPYING), which is an MIT-like license.
|
||
9 years ago
|
|
||
9 years ago
|
## Opening issues
|
||
|
|
||
|
* Make sure you have a [GitHub account](https://github.com/signup/free)
|
||
5 years ago
|
* Make sure there is no open issue on the topic
|
||
|
* [Submit a new issue](https://github.com/NixOS/nixpkgs/issues/new/choose) by choosing the kind of topic and fill out the template
|
||
9 years ago
|
|
||
|
## Submitting changes
|
||
|
|
||
2 years ago
|
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.
|
||
|
|
||
|
Below is a short excerpt of some points in there:
|
||
|
|
||
7 years ago
|
* Format the commit messages in the following way:
|
||
8 years ago
|
|
||
7 years ago
|
```
|
||
7 years ago
|
(pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc)
|
||
7 years ago
|
|
||
2 years ago
|
(Motivation for change. Link to release notes. Additional information.)
|
||
7 years ago
|
```
|
||
8 years ago
|
|
||
6 years ago
|
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).
|
||
6 years ago
|
|
||
8 years ago
|
Examples:
|
||
|
|
||
|
* nginx: init at 2.0.1
|
||
7 years ago
|
* firefox: 54.0.1 -> 55.0
|
||
2 years ago
|
https://www.mozilla.org/en-US/firefox/55.0/releasenotes/
|
||
7 years ago
|
* nixos/hydra: add bazBaz option
|
||
7 years ago
|
|
||
7 years ago
|
Dual baz behavior is needed to do foo.
|
||
7 years ago
|
* nixos/nginx: refactor config generation
|
||
7 years ago
|
|
||
7 years ago
|
The old config generation system used impure shell scripts and could break in specific circumstances (see #1234).
|
||
8 years ago
|
|
||
8 years ago
|
* `meta.description` should:
|
||
7 years ago
|
* Be capitalized.
|
||
|
* Not start with the package name.
|
||
|
* Not have a period at the end.
|
||
|
* `meta.license` must be set and fit the upstream license.
|
||
3 years ago
|
* If there is no upstream license, `meta.license` should default to `lib.licenses.unfree`.
|
||
7 years ago
|
* `meta.maintainers` must be set.
|
||
8 years ago
|
|
||
2 years ago
|
See the nixpkgs manual for more details on [standard meta-attributes](https://nixos.org/nixpkgs/manual/#sec-standard-meta-attributes).
|
||
8 years ago
|
|
||
7 years ago
|
## Writing good commit messages
|
||
|
|
||
6 years ago
|
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.
|
||
7 years ago
|
|
||
|
For package version upgrades and such a one-line commit message is usually sufficient.
|
||
|
|
||
2 years ago
|
## Rebasing between branches (i.e. from master to staging)
|
||
|
|
||
|
From time to time, changes between branches must be rebased, for example, if the
|
||
|
number of new rebuilds they would cause is too large for the target branch. When
|
||
|
rebasing, care must be taken to include only the intended changes, otherwise
|
||
|
many CODEOWNERS will be inadvertently requested for review. To achieve this,
|
||
|
rebasing should not be performed directly on the target branch, but on the merge
|
||
|
base between the current and target branch.
|
||
|
|
||
2 years ago
|
In the following example, we assume that the current branch, called `feature`,
|
||
|
is based on `master`, and we rebase it onto the merge base between
|
||
|
`master` and `staging` so that the PR can eventually be retargeted to
|
||
|
`staging` without causing a mess. The example uses `upstream` as the remote for `NixOS/nixpkgs.git`
|
||
|
while `origin` is the remote you are pushing to.
|
||
2 years ago
|
|
||
|
|
||
|
```console
|
||
2 years ago
|
# Rebase your commits onto the common merge base
|
||
|
git rebase --onto upstream/staging... upstream/master
|
||
2 years ago
|
# Force push your changes
|
||
2 years ago
|
git push origin feature --force-with-lease
|
||
2 years ago
|
```
|
||
|
|
||
2 years ago
|
The syntax `upstream/staging...` is equivalent to `upstream/staging...HEAD` and
|
||
|
stands for the merge base between `upstream/staging` and `HEAD` (hence between
|
||
|
`upstream/staging` and `upstream/master`).
|
||
|
|
||
2 years ago
|
Then change the base branch in the GitHub PR using the *Edit* button in the upper
|
||
2 years ago
|
right corner, and switch from `master` to `staging`. *After* the PR has been
|
||
2 years ago
|
retargeted it might be necessary to do a final rebase onto the target branch, to
|
||
|
resolve any outstanding merge conflicts.
|
||
|
|
||
|
```console
|
||
|
# Rebase onto target branch
|
||
|
git rebase upstream/staging
|
||
|
# Review and fixup possible conflicts
|
||
|
git status
|
||
|
# Force push your changes
|
||
2 years ago
|
git push origin feature --force-with-lease
|
||
2 years ago
|
```
|
||
2 years ago
|
|
||
4 years ago
|
## Backporting changes
|
||
|
|
||
4 years ago
|
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).
|
||
4 years ago
|
|
||
2 years ago
|
You can add a label such as `backport release-22.05` to a PR, so that merging it will
|
||
|
automatically create a backport (via [a GitHub Action](.github/workflows/backport.yml)).
|
||
|
This also works for PR's that have already been merged, and might take a couple of minutes to trigger.
|
||
|
|
||
|
You can also create the backport manually:
|
||
|
|
||
4 years ago
|
1. Take note of the commits in which the change was introduced into `master` branch.
|
||
2 years ago
|
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`.
|
||
4 years ago
|
3. Create a branch for your change, e.g. `git checkout -b backport`.
|
||
4 years ago
|
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.
|
||
2 years ago
|
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]`.
|
||
3 years ago
|
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.
|
||
4 years ago
|
|
||
3 years ago
|
## Criteria for Backporting changes
|
||
|
|
||
|
Anything that does not cause user or downstream dependency regressions can be backported. This includes:
|
||
|
- New Packages / Modules
|
||
|
- Security / Patch updates
|
||
|
- Version updates which include new functionality (but no breaking changes)
|
||
3 years ago
|
- Services which require a client to be up-to-date regardless. (E.g. `spotify`, `steam`, or `discord`)
|
||
|
- Security critical applications (E.g. `firefox`)
|
||
3 years ago
|
|
||
2 years ago
|
## Generating 22.11 Release Notes
|
||
3 years ago
|
|
||
3 years ago
|
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.
|
||
|
|
||
2 years ago
|
Steps for updating 22.11 Release notes:
|
||
3 years ago
|
|
||
2 years ago
|
1. Edit `nixos/doc/manual/release-notes/rl-2211.section.md` with the desired changes
|
||
|
2. Run `./nixos/doc/manual/md-to-db.sh` to render `nixos/doc/manual/from_md/release-notes/rl-2211.section.xml`
|
||
|
3. Include changes to `rl-2211.section.md` and `rl-2211.section.xml` in the same commit.
|
||
3 years ago
|
|
||
8 years ago
|
## Reviewing contributions
|
||
|
|
||
5 years ago
|
See the nixpkgs manual for more details on how to [Review contributions](https://nixos.org/nixpkgs/manual/#chap-reviewing-contributions).
|