How/where/what to document
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ài liệu
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Đình trệ
- Lĩnh vực
- documentation
Hướng nghiên cứu
Không có tệp, bài kiểm thử hoặc điểm vào cụ thể nào được xác định. Trước tiên, hãy xem xét README hiện có và cấu trúc tài liệu, sau đó xác định một hướng dẫn đóng góp nêu rõ quyền, các route, luồng người dùng và thông tin bắt đầu nên được đặt ở đâu.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
I have always felt that there should be more of a process/guidelines when it comes to documenting stuff. I imagine there is a lot overlap with what you want to be documented across projects (permissions/routes/user-flows/getting-started/...).
It would help to have a specific guide to follow so that I know where to add this piece of information rather than just stick it on the end of a potentially long readme.
- Ngôn ngữ chính
- Không có dữ liệu ngôn ngữ
- Star
- 92
- Fork
- 9
- 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
- Không có Dockerfile hay tệp Docker Compose
- Không 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 dwyl/contributing
-
bug chore starter
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 38/100
dwyl/contributing#119 · 1 reaction ·
-
'Why? What? Who? How?' formatĐang mởenhancement starter
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 35/100
dwyl/contributing#118 · 1 reaction ·
-
How to do a code reviewĐang mởdiscuss enhancement
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 25/100
dwyl/contributing#113 · 2 reaction ·
-
discuss enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 35/100
dwyl/contributing#112 · 1 reaction ·
-
Draft Pull Requests!Đang mởdiscuss enhancement
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 42/100
dwyl/contributing#111 · 2 bình luận · 3 reaction ·
Tất cả issue của dwyl/contributing
Issue tương tự
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 86/100
ranxianglei/billion-context#5893 ·
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 74/100
Maintainer thường phản hồi trong vòng 1 ngày
-
vuln:LOW
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
Maintainer thường phản hồi trong vòng 1 ngày
-
after-v0.1.0 bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Maintainer thường phản hồi trong vòng 1 ngày
-
agent-butler-finding bug
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 84/100
jordansmall/spindrift#6557 ·
Maintainer thường phản hồi trong vòng 1 ngày