MattIPv4 / MattIPv4/PyDMXControl
[Python] Implement docstrings and testing
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 143
- Fork
- 23
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Currently the library has a lot of code dumped throughout that has no documentation associated to explain what it does. Additionally, there is no real testing in place to ensure older methods are not broken by never changes etc.
Therefor, implementing correct docstrings throughout the code and implementing proper testing would be a good way to bring up the quality of the library.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
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
Issue không nêu tệp, kiểm thử hay điểm vào nào. Hãy bắt đầu bằng việc khảo sát thư viện Python để xác định phạm vi của docstring và kiểm thử hồi quy; yêu cầu để hoàn thành là mã được lập tài liệu và có các kiểm thử có ý nghĩa bảo vệ các phương thức hiện có.
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
- documentation, testing
- Loại issue
- Tài liệu
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 20/100