srid/haskell-flake

Add `pre-commit-nix` documentation

Open

#136 opened on 2023年3月31日

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)

説明

  • 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

コントリビューターガイド

調査方針
既存のNix flake設定とpre commit nixフックの例を確認し、treefmtのような既存のフックを有効にする方法と、インポートを介して新しいフックを記述する方法を説明するドキュメントを作成します。
技術スタック
なし
領域
developer experience
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Git
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75