NixOS / NixOS/nix.dev

recommend building projects forward-compatible with flakes

Open
#136 7 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nix
Stars
4k
Forks
339
Avg merge
2d 11h
Merged PRs (30d)
7

Description

New users sometimes are interested in flakes and have heard of them, but may avoid them due to their experimental status and perceived additional complexity. A friendly way to introduce it is to build a project's .nix files in a way that are compatible with being called from flakes. And then a simple wrapper flake.nix provides a backward-compatible upgrade path when they desire.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing nix.dev guidance for building projects and the .nix files it discusses. Define how to explain forward-compatible files and a backward-compatible flake.nix wrapper, then update the documentation so newcomers can understand the upgrade path and when they are done.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.