MetaMask / MetaMask/contributor-docs
Create outline for documentation around the core monorepo
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- JavaScript
- Star
- 86
- Fork
- 42
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
This issue is for creating the outline of what would need to go into the contributor documenation around the the architecture of the core monorepo.
Please use the epic for inspiration on what to include here. Epic 1588
As part of this work please get feedback from team to finalize the outline and then create issues for filling in each of the areas of the outline. Please add the tickets to the epic and ensure they are pointed.
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 bằng việc xem xét Epic 1588 để xác định các chủ đề về kiến trúc cần đưa vào dàn ý tài liệu dành cho contributor. Thu thập phản hồi của nhóm để hoàn thiện dàn ý, sau đó tạo một issue cho mỗi lĩnh vực, thêm các ticket đó vào epic và đảm bảo chúng được gán story points. Issue không nêu tên tệp hoặc bài kiểm thử nào.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- javascript
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 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
- 25/100