2.7 KiB
Contributing to nix.dev
nix.dev is a community effort to collect, create, and maintain world-class learning resources for Nix.
We strongly encourage everyone interested to contribute by asking informed questions or directly proposing changes.
Make a pull request if you want to introduce an incremental change. Note our considerations on licensing and attribution.
Open an issue if you want to clarify something not evident from what is provided in this repository, or if you want to discuss a significant change before starting to work on it.
Code of conduct
Adapted from the Contributor Covenant and The Carpentries Code of Conduct:
- Use welcoming and inclusive language
- Show empathy and respect towards other people
- Be respectful of different viewpoints and experiences
- Give and gracefully accept constructive criticism
- Focus on what is best for the community
Updating reference manuals
With the current setup, the Nix manual hosted on nix.dev does not get updated automatically with new releases. The following manual steps are required:
-
Regularly update the inputs to use the latest versions of the Nix release branches with
nix shell --run "niv update"To avoid long build times, make sure Nix can be fetched from the cache. If it doesn't, find the latest commit that is built by Hydra. For example, to pin Nix 2.18:
niv update nix_2-18 -r f5f4de6a550327b4b1a06123c2e450f1b92c73b6 -
On each new Nix release:
-
Add the latest version in
default.nix. For example, to add Nix 2.19:niv add nixos/nix -n nix_2-19 -b 2.19-maintenance -
Reference the latest version in
source/reference/nix-manual.md.
-
-
If an unstable or stable release of Nixpkgs adopt a new version of Nix, update the corresponding references here.
Also update URLs to the the Nix manual to the version used by Nixpkgs unstable. For example, if one wants to move from 2.18 to 2.19:
sed -i 's#https://nix.dev/manual/nix/2.18/#https://nix.dev/manual/nix/2.19/#g' $(ls **/*.md)
Contributor guides
Please read Contributing Documentation.