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

Abierto
#7 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
62/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
github-actions, python

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
1
Forks
4
Merge medio
12 d 21 h
PR fusionados (30 d)
1

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de alphacrack/python-maithili-dsl

Todos los issues de alphacrack/python-maithili-dsl

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.