srid/haskell-flake

Add `pre-commit-nix` documentation

Open

#136 opened on Mar 31, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Nix (26 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (231 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Look at the existing nix flake configuration and examples of pre commit nix hooks, then write documentation covering how to enable existing hooks like treefmt and how to write new hooks via imports.
Tech stack
None
Domain
developer experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75