[QUALITY] Add type hints to public functions and mypy to CI

Offen
#7 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
62/100
Issue-Typ
Refactoring
Klarheit
Klar beschrieben
Aktivitätsstatus
Ruhig
Tech-Stack
github-actions, python

Rechercherichtung

Start with the exports in maithili_dsl/__init__.py, then read maithili_dsl/transpile.py and maithili_dsl/cli.py to see the unannotated signatures. Add annotations to the public functions first, then helpers, and check the result with a local mypy run. Add mypy to requirements-dev.txt and a step to .github/workflows/ci.yml. Done when the public functions are annotated and the CI mypy step passes without --strict.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

help wanted P2 quality

No function signatures in maithili_dsl/ have type annotations (checked transpile.py and cli.py). Type hints make the public API (transpile_maithili_code, lint_maithili_code, translate_exception_to_maithili, convert_devanagari_numerals) much easier for contributors to understand.

Scope:

  • Annotate all public functions exported in maithili_dsl/__init__.py, then internal helpers
  • Add mypy to requirements-dev.txt and a mypy step to .github/workflows/ci.yml
  • Start permissive (no --strict), tighten later

From BACKLOG.md item 12. Also listed under Future Goals in the README.

Vorherrschende Sprache
Python
Sterne
1
Forks
4
Ø Merge
12 T. 21 Std.
Gemergte PRs (30 T.)
1

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus alphacrack/python-maithili-dsl

Alle Issues in alphacrack/python-maithili-dsl

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.