openedx / openedx/code-annotations
Ensure only defined annotations are allowed
Đang mở
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 5
- Fork
- 13
- Merge trung bình
- 18 giờ 26 phút
- Pull request đã merge (30 ngày)
- 4
Mô tả
At this time, users are not given any linting warnings when undefined annotations are used, including misspellings.
Additional Notes:
- An example: someone might use
toggle_warningsinstead oftoggle_warning. - It has been noted that removing the ability to comment between annotations (see https://github.com/openedx/code-annotations/issues/89) would make this simpler to implement.
- Linting might be implemented here: https://github.com/openedx/edx-lint/blob/7573005f89df7f78142a2af86673206e8b43c4d5/edx_lint/pylint/annotations_check.py#L291
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.
Hướng nghiên cứu
Bắt đầu với edx_lint/pylint/annotations_check.py quanh dòng 291 để hiểu entry point linting hiện có. Xem lại phần thảo luận của issue #89 về các comment giữa những annotation, sau đó xác định hoàn thành là khi phát ra cảnh báo nếu tên annotation chưa được định nghĩa hoặc bị viết sai, chẳng hạn như toggle_warnings thay vì toggle_warning.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- python
- Lĩnh vực
- tooling
- Loại issue
- Tính năng
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 45/100