srid / srid/haskell-flake

Add `pre-commit-nix` documentation

Open
#136 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue
Dominant language
Nix
Stars
240
Forks
27
PR merge metrics
No merged PRs in 30d

Description

  • How to use pre-commit to enable existing hooks (eg: treefmt)
  • How to write new hooks (via imports for better modularizing)

Ex: https://github.com/nammayatri/nammayatri/pull/361

Contributor guide

No contributing guide indexed for this repository

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

Use the pre-commit-nix documentation request as the starting point, and review the linked nammayantri pull request for an example. Document how to enable existing hooks such as treefmt and how to write new hooks using imports for modularization; the work is done when both workflows are explained clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.