[QUALITY] Add type hints to public functions and mypy to CI
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 62/100
- Issue 类型
- 重构
- 描述清晰度
- 描述清楚
- 活跃度
- 冷清
- 技术栈
- github-actions, python
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- Python
- 星标
- 1
- 派生
- 4
- 平均合并
- 12 天 21 小时
- 30 天内合并 PR
- 1
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
alphacrack/python-maithili-dsl 的其他 Issue
-
help wanted infra P2 testing
难度 2/5 1-3 小时 新手友好度 80/100
-
documentation enhancement good first issue help wanted P3
难度 2/5 1-3 小时 新手友好度 75/100
-
documentation good first issue P3
难度 1/5 1 小时以内 新手友好度 88/100
-
area:linter enhancement good first issue P3 translation
难度 2/5 半天 新手友好度 66/100
-
area:cli enhancement good first issue P3
难度 2/5 1-3 小时 新手友好度 82/100
查看 alphacrack/python-maithili-dsl 的全部 Issue
相似的 Issue
-
documentation good first issue
难度 2/5 1-3 小时 新手友好度 88/100
JheysonJhordyHuarauyaRiquelme/sprocguard#18 ·
维护者通常 1 天内回复
-
enhancement good first issue help wanted
难度 2/5 1-3 小时 新手友好度 80/100
dlq/synthpopcan#59 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
mdn/translated-content#40220 ·
维护者通常 4 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 84/100
ETSInitiative/PETSIRD#243 ·
维护者通常 1 天内回复
-
deferred p2
难度 2/5 1-3 小时 新手友好度 70/100
cuadrao-ai/argus#2160 ·
维护者通常 1 天内回复