[QUALITY] Add type hints to public functions and mypy to CI
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 62/100
- Loại issue
- Tái cấu trúc
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- github-actions, python
- Lĩnh vực
- ci-cd, developer-experience
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- Python
- Star
- 1
- Fork
- 4
- Merge trung bình
- 12 ngày 21 giờ
- Pull request đã merge (30 ngày)
- 1
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của alphacrack/python-maithili-dsl
-
help wanted infra P2 testing
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 80/100
-
documentation enhancement good first issue help wanted P3
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
-
documentation good first issue P3
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
-
area:linter enhancement good first issue P3 translation
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 66/100
-
area:cli enhancement good first issue P3
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
Tất cả issue của alphacrack/python-maithili-dsl
Issue tương tự
-
documentation good first issue
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
JheysonJhordyHuarauyaRiquelme/sprocguard#18 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
enhancement good first issue help wanted
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 80/100
dlq/synthpopcan#59 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
mdn/translated-content#40220 ·
Maintainer thường phản hồi trong vòng 4 ngày
-
enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
ETSInitiative/PETSIRD#243 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
deferred p2
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
cuadrao-ai/argus#2160 ·
Maintainer thường phản hồi trong vòng 1 ngày