InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Improving the "Common Requirements" pattern
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- HTML
- Star
- 853
- Fork
- 206
- Merge trung bình
- 1 ngày 23 giờ
- Pull request đã merge (30 ngày)
- 2
Mô tả
Some ideas for improving the Common Requirements pattern:
- Improve the Patlet - escpecially describe how the Solution is improving upon the Problem
- Break up Forces into bullets - so that readers can check more easily if these forces apply in their orgs as well
- Decide what to do with the Resulting Context: It currently focuses mostly on other related challenges that may need to be solved after this pattern is in place. However it lacks explanation of how this pattern has helped to address the problem i.e. how can people confirm "did it work"?
- improving the visual e.g. by creating a new version digitally (so no scan), and explaining in the pattern what that visual illustrates
To even level the pattern up to Validated, we would have to find 2 more Known Instances of orgs using this pattern. As this might be hard to do, it could be achieved in multiple steps (and PRs) over time.
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 cách đọc patterns/2-structured/common-requirements.md và phần trong sổ tay contributor được liên kết trong issue, sau đó kiểm tra assets/img/CommonReqtsv2.jpg. Chia công việc thành các cải tiến về pattern, hình ảnh và validation được liệt kê; hoàn tất có nghĩa là các thay đổi đã chọn được ghi lại và pattern có đủ bằng chứng bắt buộc, bao gồm thêm hai Known Instances nếu theo đuổi trạng thái Validated.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- markdown
- 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
- 35/100