srid/haskell-flake

Add `pre-commit-nix` documentation

Open

#136 aberto em 31 de mar. de 2023

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

Métricas do repositório

Stars
 (231 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Veja a configuração existente do Nix flake e exemplos de hooks pre commit nix, depois escreva documentação cobrindo como habilitar hooks existentes como treefmt e como escrever novos hooks via imports.
Pilha de tecnologia
None
Domain
developer experience
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75