aicuriousminds/retrieval-augmented-generation

Set up Python Linting & TypeChecking

Ouverte

#4 ouverte le 25 mai 2024

Voir sur GitHub
 (0 commentaire) (0 réaction) (1 personne assignée)Python (0 fork)auto 404
good first issue

Métriques du dépôt

Stars
 (1 étoile)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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

Guide contributeur

Direction de recherche
Configurez Ruff pour le linting et MyPy pour la vérification de type, puis configurez les hooks pre commit pour les exécuter automatiquement.
Stack technique
python
Domaine
developer experience
Type d'issue
Maintenance
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80