aicuriousminds/retrieval-augmented-generation

Set up Python Linting & TypeChecking

Aperta

#4 aperta il 25 mag 2024

Vedi su GitHub
 (0 commenti) (0 reazioni) (1 assegnatario)Python (0 fork)auto 404
good first issue

Metriche repository

Star
 (1 stella)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Configura Ruff per il linting e MyPy per il typechecking, quindi configura i pre commit hook per eseguirli automaticamente.
Tech stack
python
Dominio
developer experience
Tipo issue
Manutenzione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80