typelevel / typelevel/typelevel.g8

flake.lock questions

Open
#7 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
14
Forks
7
Avg merge
5d 16h
Merged PRs (30d)
3

Description

When a user generates a template and uses the provided flake.nix via nix develop (see https://github.com/typelevel/typelevel-nix for more details) it generates a flake.lock file.

  1. Should the user be encouraged to commit this file to their git repo?
    Judging from https://github.com/http4s/http4s/blob/series/0.23/flake.lock the answer is yes, we should commit the lock file to the repo.

  2. Should we be templating the lockfile for the user so it's generated as part of the giter8 init process?
    If not, I think we ought to add a little mention of the expectations to the outer README here.

cc. @rossabaker

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 inspecting the provided flake.nix and the giter8 initialization process, then compare the repository's expectations with the linked http4s flake.lock example. Check the outer README for existing guidance; the work is done when the lockfile policy and whether initialization should generate it are clearly resolved and documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.