aicuriousminds/retrieval-augmented-generation

Set up Python Linting & TypeChecking

Offen

#4 geöffnet am 25.05.2024

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Python (0 Forks)auto 404
good first issue

Repository-Metriken

Stars
 (1 Stern)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Richten Sie Ruff für das Linting und MyPy für die Typprüfung ein, und konfigurieren Sie dann Pre Commit Hooks, um sie automatisch auszuführen.
Tech Stack
python
Domain
developer experience
Issue Type
Wartung
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PythonGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80