aicuriousminds/retrieval-augmented-generation

Set up Python Linting & TypeChecking

Aberta

#4 aberto em 25 de mai. de 2024

Ver no GitHub
 (0 comentário) (0 reação) (1 responsável)Python (0 fork)auto 404
good first issue

Métricas do repositório

Stars
 (1 estrela)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

Currently we don't have any linting or typechecking. My suggestions are:

Assuming this, we should:

  • add linting
  • add typechecking
  • add git pre-commit hook to ensure that these are run on commit

Guia do colaborador

Direção de pesquisa
Configure o Ruff para linting e o MyPy para typechecking, em seguida, configure os ganchos de pre commit para executá los automaticamente.
Pilha de tecnologia
python
Domain
developer experience
Tipo Issue
Manutençã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.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80