CONTRIBUTING.md: Move pull request template section to the bottom
This commit is contained in:
Silvan Mosberger
parent
44293fb032
commit
9489e19e21
139
CONTRIBUTING.md
139
CONTRIBUTING.md
@ -121,76 +121,6 @@ When pull requests are made, our tooling automation bot,
|
|||||||
[OfBorg](https://github.com/NixOS/ofborg) will perform various checks
|
[OfBorg](https://github.com/NixOS/ofborg) will perform various checks
|
||||||
to help ensure expression quality.
|
to help ensure expression quality.
|
||||||
|
|
||||||
#### Pull Request Template {#submitting-changes-pull-request-template}
|
|
||||||
|
|
||||||
The pull request template helps determine what steps have been made for a contribution so far, and will help guide maintainers on the status of a change. The motivation section of the PR should include any extra details the title does not address and link any existing issues related to the pull request.
|
|
||||||
|
|
||||||
When a PR is created, it will be pre-populated with some checkboxes detailed below:
|
|
||||||
|
|
||||||
##### Tested using sandboxing {#submitting-changes-tested-with-sandbox}
|
|
||||||
|
|
||||||
When sandbox builds are enabled, Nix will setup an isolated environment for each build process. It is used to remove further hidden dependencies set by the build environment to improve reproducibility. This includes access to the network during the build outside of `fetch*` functions and files outside the Nix store. Depending on the operating system access to other resources are blocked as well (ex. inter process communication is isolated on Linux); see [sandbox](https://nixos.org/nix/manual/#conf-sandbox) in Nix manual for details.
|
|
||||||
|
|
||||||
Sandboxing is not enabled by default in Nix due to a small performance hit on each build. In pull requests for [nixpkgs](https://github.com/NixOS/nixpkgs/) people are asked to test builds with sandboxing enabled (see `Tested using sandboxing` in the pull request template) because in<https://nixos.org/hydra/> sandboxing is also used.
|
|
||||||
|
|
||||||
Depending if you use NixOS or other platforms you can use one of the following methods to enable sandboxing **before** building the package:
|
|
||||||
|
|
||||||
- **Globally enable sandboxing on NixOS**: add the following to `configuration.nix`
|
|
||||||
|
|
||||||
```nix
|
|
||||||
nix.useSandbox = true;
|
|
||||||
```
|
|
||||||
|
|
||||||
- **Globally enable sandboxing on non-NixOS platforms**: add the following to: `/etc/nix/nix.conf`
|
|
||||||
|
|
||||||
```ini
|
|
||||||
sandbox = true
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Built on platform(s) {#submitting-changes-platform-diversity}
|
|
||||||
|
|
||||||
Many Nix packages are designed to run on multiple platforms. As such, it’s important to let the maintainer know which platforms your changes have been tested on. It’s not always practical to test a change on all platforms, and is not required for a pull request to be merged. Only check the systems you tested the build on in this section.
|
|
||||||
|
|
||||||
##### Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests) {#submitting-changes-nixos-tests}
|
|
||||||
|
|
||||||
Packages with automated tests are much more likely to be merged in a timely fashion because it doesn’t require as much manual testing by the maintainer to verify the functionality of the package. If there are existing tests for the package, they should be run to verify your changes do not break the tests. Tests can only be run on Linux. For more details on writing and running tests, see the [section in the NixOS manual](https://nixos.org/nixos/manual/index.html#sec-nixos-tests).
|
|
||||||
|
|
||||||
##### Tested compilation of all pkgs that depend on this change using `nixpkgs-review` {#submitting-changes-tested-compilation}
|
|
||||||
|
|
||||||
If you are updating a package’s version, you can use `nixpkgs-review` to make sure all packages that depend on the updated package still compile correctly. The `nixpkgs-review` utility can look for and build all dependencies either based on uncommitted changes with the `wip` option or specifying a GitHub pull request number.
|
|
||||||
|
|
||||||
Review changes from pull request number 12345:
|
|
||||||
|
|
||||||
```ShellSession
|
|
||||||
nix-shell -p nixpkgs-review --run "nixpkgs-review pr 12345"
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, with flakes (and analogously for the other commands below):
|
|
||||||
|
|
||||||
```ShellSession
|
|
||||||
nix run nixpkgs#nixpkgs-review -- pr 12345
|
|
||||||
```
|
|
||||||
|
|
||||||
Review uncommitted changes:
|
|
||||||
|
|
||||||
```ShellSession
|
|
||||||
nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
|
|
||||||
```
|
|
||||||
|
|
||||||
Review changes from last commit:
|
|
||||||
|
|
||||||
```ShellSession
|
|
||||||
nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"
|
|
||||||
```
|
|
||||||
|
|
||||||
##### Tested execution of all binary files (usually in `./result/bin/`) {#submitting-changes-tested-execution}
|
|
||||||
|
|
||||||
It’s important to test any executables generated by a build when you change or create a package in nixpkgs. This can be done by looking in `./result/bin` and running any files in there, or at a minimum, the main executable for the package. For example, if you make a change to texlive, you probably would only check the binaries associated with the change you made rather than testing all of them.
|
|
||||||
|
|
||||||
##### Meets Nixpkgs contribution standards {#submitting-changes-contribution-standards}
|
|
||||||
|
|
||||||
The last checkbox is fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). The contributing document has detailed information on standards the Nix community has for commit messages, reviews, licensing of contributions you make to the project, etc... Everyone should read and understand the standards the community has for contributing before submitting a pull request.
|
|
||||||
|
|
||||||
#### Rebasing between branches (i.e. from master to staging)
|
#### Rebasing between branches (i.e. from master to staging)
|
||||||
|
|
||||||
From time to time, changes between branches must be rebased, for example, if the
|
From time to time, changes between branches must be rebased, for example, if the
|
||||||
@ -696,3 +626,72 @@ Names of files and directories should be in lowercase, with dashes between words
|
|||||||
|
|
||||||
- Arguments should be listed in the order they are used, with the exception of `lib`, which always goes first.
|
- Arguments should be listed in the order they are used, with the exception of `lib`, which always goes first.
|
||||||
|
|
||||||
|
## Pull Request Template {#submitting-changes-pull-request-template}
|
||||||
|
|
||||||
|
The pull request template helps determine what steps have been made for a contribution so far, and will help guide maintainers on the status of a change. The motivation section of the PR should include any extra details the title does not address and link any existing issues related to the pull request.
|
||||||
|
|
||||||
|
When a PR is created, it will be pre-populated with some checkboxes detailed below:
|
||||||
|
|
||||||
|
### Tested using sandboxing {#submitting-changes-tested-with-sandbox}
|
||||||
|
|
||||||
|
When sandbox builds are enabled, Nix will setup an isolated environment for each build process. It is used to remove further hidden dependencies set by the build environment to improve reproducibility. This includes access to the network during the build outside of `fetch*` functions and files outside the Nix store. Depending on the operating system access to other resources are blocked as well (ex. inter process communication is isolated on Linux); see [sandbox](https://nixos.org/nix/manual/#conf-sandbox) in Nix manual for details.
|
||||||
|
|
||||||
|
Sandboxing is not enabled by default in Nix due to a small performance hit on each build. In pull requests for [nixpkgs](https://github.com/NixOS/nixpkgs/) people are asked to test builds with sandboxing enabled (see `Tested using sandboxing` in the pull request template) because in<https://nixos.org/hydra/> sandboxing is also used.
|
||||||
|
|
||||||
|
Depending if you use NixOS or other platforms you can use one of the following methods to enable sandboxing **before** building the package:
|
||||||
|
|
||||||
|
- **Globally enable sandboxing on NixOS**: add the following to `configuration.nix`
|
||||||
|
|
||||||
|
```nix
|
||||||
|
nix.useSandbox = true;
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Globally enable sandboxing on non-NixOS platforms**: add the following to: `/etc/nix/nix.conf`
|
||||||
|
|
||||||
|
```ini
|
||||||
|
sandbox = true
|
||||||
|
```
|
||||||
|
|
||||||
|
### Built on platform(s) {#submitting-changes-platform-diversity}
|
||||||
|
|
||||||
|
Many Nix packages are designed to run on multiple platforms. As such, it’s important to let the maintainer know which platforms your changes have been tested on. It’s not always practical to test a change on all platforms, and is not required for a pull request to be merged. Only check the systems you tested the build on in this section.
|
||||||
|
|
||||||
|
### Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests) {#submitting-changes-nixos-tests}
|
||||||
|
|
||||||
|
Packages with automated tests are much more likely to be merged in a timely fashion because it doesn’t require as much manual testing by the maintainer to verify the functionality of the package. If there are existing tests for the package, they should be run to verify your changes do not break the tests. Tests can only be run on Linux. For more details on writing and running tests, see the [section in the NixOS manual](https://nixos.org/nixos/manual/index.html#sec-nixos-tests).
|
||||||
|
|
||||||
|
### Tested compilation of all pkgs that depend on this change using `nixpkgs-review` {#submitting-changes-tested-compilation}
|
||||||
|
|
||||||
|
If you are updating a package’s version, you can use `nixpkgs-review` to make sure all packages that depend on the updated package still compile correctly. The `nixpkgs-review` utility can look for and build all dependencies either based on uncommitted changes with the `wip` option or specifying a GitHub pull request number.
|
||||||
|
|
||||||
|
Review changes from pull request number 12345:
|
||||||
|
|
||||||
|
```ShellSession
|
||||||
|
nix-shell -p nixpkgs-review --run "nixpkgs-review pr 12345"
|
||||||
|
```
|
||||||
|
|
||||||
|
Alternatively, with flakes (and analogously for the other commands below):
|
||||||
|
|
||||||
|
```ShellSession
|
||||||
|
nix run nixpkgs#nixpkgs-review -- pr 12345
|
||||||
|
```
|
||||||
|
|
||||||
|
Review uncommitted changes:
|
||||||
|
|
||||||
|
```ShellSession
|
||||||
|
nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
|
||||||
|
```
|
||||||
|
|
||||||
|
Review changes from last commit:
|
||||||
|
|
||||||
|
```ShellSession
|
||||||
|
nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Tested execution of all binary files (usually in `./result/bin/`) {#submitting-changes-tested-execution}
|
||||||
|
|
||||||
|
It’s important to test any executables generated by a build when you change or create a package in nixpkgs. This can be done by looking in `./result/bin` and running any files in there, or at a minimum, the main executable for the package. For example, if you make a change to texlive, you probably would only check the binaries associated with the change you made rather than testing all of them.
|
||||||
|
|
||||||
|
### Meets Nixpkgs contribution standards {#submitting-changes-contribution-standards}
|
||||||
|
|
||||||
|
The last checkbox is fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md). The contributing document has detailed information on standards the Nix community has for commit messages, reviews, licensing of contributions you make to the project, etc... Everyone should read and understand the standards the community has for contributing before submitting a pull request.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user