[QUALITY] Add type hints to public functions and mypy to CI
まだ誰も着手していません。
評価
- 難易度
- 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時間
- マージ済み PR（30日）
- 1
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 日以内に返信