opensearch-project/demos

[FEATURE][DocBot] Add mypy type checking

Aperta

#92 aperta il 6 nov 2023

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari) (18 fork)auto 404
OSCIenhancementgood first issue

Metriche repository

Star
 (4 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Is your feature request related to a problem?

At the moment we have types in our project but we dont have a pattern for regularly checking and validating the types.

What solution would you like?

As a pre-commit hook we should enable mypy which will help us with doing typechecking.

Additionally we need to go through and validate the types are correct for the things that we have typed.

Guida contributor

Direzione di ricerca
Guarda la configurazione pre esistente di pre commit nel repository, aggiungi un hook mypy a .pre commit config.yaml e configura le impostazioni di mypy (es. mypy.ini). Assicurati che tutto il codice esistente superi i controlli di tipo o aggiungi hint di tipo dove mancano.
Tech stack
python
Dominio
tooling
Tipo issue
Funzionalità
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
PythonGitpre commit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75