Description
The project provides a flake.nix with a dev shell containing all required dependencies, plus a .envrc for direnv integration, but neither CONTRIBUTE.md nor README.md mention Nix as a setup option.
Update the Requirements/Setup section in docs/templates/CONTRIBUTE.md.j2 to document:
- Nix flake as an alternative to manual package installation
- The experimental features that must be enabled (
nix-command, flakes) — either via ~/.config/nix/nix.conf or the --extra-experimental-features flag
- Optional direnv integration via the existing
.envrc
Documentation Type
Update existing documentation
Target Files
docs/templates/CONTRIBUTE.md.j2 (source template)
Acceptance Criteria
Changelog Category
Changed
Additional Context
The flake.nix and .envrc were added without corresponding documentation. Users encountering Nix for the first time hit error: experimental Nix feature 'nix-command' is disabled with no guidance.
Description
The project provides a
flake.nixwith a dev shell containing all required dependencies, plus a.envrcfor direnv integration, but neitherCONTRIBUTE.mdnorREADME.mdmention Nix as a setup option.Update the Requirements/Setup section in
docs/templates/CONTRIBUTE.md.j2to document:nix-command,flakes) — either via~/.config/nix/nix.confor the--extra-experimental-featuresflag.envrcDocumentation Type
Update existing documentation
Target Files
docs/templates/CONTRIBUTE.md.j2(source template)Acceptance Criteria
nix-commandandflakesexperimental featuresnix developusage and optional direnv setupCONTRIBUTE.mdregenerated withjust docsChangelog Category
Changed
Additional Context
The
flake.nixand.envrcwere added without corresponding documentation. Users encountering Nix for the first time hiterror: experimental Nix feature 'nix-command' is disabledwith no guidance.