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

Ouverte
#7 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
62/100
Type d'issue
Refactorisation
Clarté
Clairement spécifiée
Activité
Calme
Stack technique
github-actions, python

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Python
Étoiles
1
Forks
4
Merge moyen
12 j 21 h
PR mergées (30 j)
1

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de alphacrack/python-maithili-dsl

Toutes les issues de alphacrack/python-maithili-dsl

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.