Code a tool to update a JSON reference file
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- python
- Lĩnh vực
- documentation, tooling
Hướng nghiên cứu
Bắt đầu bằng cách đọc quy trình tạo tài liệu của repository và xác định nơi reference JSON được tạo ra. Xác định cách cung cấp và duy trì các trường bổ sung như ví dụ mã, liên kết hướng dẫn và references, sau đó xác định các tiêu chí chấp nhận để cập nhật reference đã tạo mà không làm mã nguồn trở nên rườm rà.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
To make the docs maker as flexible as possible, we'd like to support having JSON keys or metadata on top of the one generated by the tool. That is to say, extra fields that may not be in the tool, like code examples, links to tutorials, references... extra information that would clutter the source code.
- Ngôn ngữ chính
- Python
- Star
- 297
- Fork
- 26
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. Hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
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 GDQuest/gdscript-docs-maker
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 38/100
GDQuest/gdscript-docs-maker#95 · 4 bình luận · 1 reaction ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 45/100
-
enhancement
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
-
enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 55/100
GDQuest/gdscript-docs-maker#86 · 1 reaction ·
-
index is being generated blankĐang mởbug
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
GDQuest/gdscript-docs-maker#71 · 3 bình luận ·
Tất cả issue của GDQuest/gdscript-docs-maker
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
PedestrianDynamics/pyFDS-Evac#343 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
theskumar/python-dotenv#708 ·
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
Maintainer thường phản hồi trong vòng 2 ngày
-
Docs Timedelta
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
pandas-dev/pandas#69919 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
API documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
zephyrproject-rtos/west#1009 · 2 bình luận ·
Maintainer thường phản hồi trong vòng 3 ngày