[QUALITY] Add type hints to public functions and mypy to CI
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
- Área
- ci-cd, developer-experience
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
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
mypytorequirements-dev.txtand 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
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de alphacrack/python-maithili-dsl
-
help wanted infra P2 testing
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
-
documentation enhancement good first issue help wanted P3
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
-
documentation good first issue P3
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
-
area:linter enhancement good first issue P3 translation
Dificultad 2/5 Medio día Aptitud para principiantes 66/100
-
area:cli enhancement good first issue P3
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Todos los issues de alphacrack/python-maithili-dsl
Issues similares
-
documentation good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
JheysonJhordyHuarauyaRiquelme/sprocguard#18 ·
Los mantenedores suelen responder en 1 día
-
enhancement good first issue help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 80/100
dlq/synthpopcan#59 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
mdn/translated-content#40220 ·
Los mantenedores suelen responder en 4 días
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
ETSInitiative/PETSIRD#243 ·
Los mantenedores suelen responder en 1 día
-
deferred p2
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
cuadrao-ai/argus#2160 ·
Los mantenedores suelen responder en 1 día