InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

🚧 Get "Modular Code" published in our book

Đang mở
#529 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

:book: Type - Content Work 2-structured
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ả

WIP: I am drafting this issue to describe the work required to level up a given pattern from Initial (Level 1) to Structured (Level 2). I am using this pattern as an example for this. I am hoping that later we can extract generalizable points into a GitHub issue template, that we can use whenever we want to do such "leveling up" for other patterns.

Meta

Goal

Improve the given pattern to get it published in our InnerSource patterns online book at patterns.innersourcecommons.org.

Once published in the book, the pattern can be discovered more easily by people looking to improve their InnerSource practices. The upside for pattern authors and their orgs is an increased brand recognition, and positioning themselves as an InnerSource thought leader.

Getting Started

  • We recommend that you review the Structured (L2) Requirements to understand the quality expectations we have set for the patterns in our book.
  • Double check if there were any open discussion points in previous PRs about this pattern. You might built on these discussion points to improve the pattern further.

Possible Improvements

Here some examples of possible activities that might improve this pattern:

  • Since publishing this pattern as Initial, did you make any new experiences while applying this pattern?
  • Once we have published the pattern in the book it becomes harder to change the title (and filename) without breaking URLs. Therefore we recommend to confirm one more time if you are happy with the title of the pattern (and its file name). For further tips see Naming Patterns.
  • Are there any other L2/Structured patterns that you could link to from within this pattern?
  • Are there any resources that you could link to that would help to either validate your pattern, or make it easier for the readers to understand it? Please confirm that these are resources that you trust.
  • Determine to which phase of the InnerSource Program Mind Map the pattern should be added to (add it to at least one phase). This makes it easier for readers to discover your pattern as well.
  • (optional) Do you know any other organizations using this pattern? Getting them to contribute their knowledge to the pattern and adding them as a Known Instance significantly hardens the pattern. Activities around this can also happen in a new issue/PR.

The above are just some suggestions.

You are the expert on your pattern, so please make your own judgement calls about how your pattern can be improved.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với patterns/1-initial/modular-code.md, sau đó đọc Structured (L2) Requirements trong meta/contributor-handbook.md và hướng dẫn đặt tên trong meta/pattern-style-guide.md. Xem lại các cuộc thảo luận hoặc PR trước đây về pattern, và kiểm tra pattern-categorization/README.md để biết cách phân loại. Hoàn tất có nghĩa là pattern đáp ứng các yêu cầu L2 và sẵn sàng được xuất bản trong sách trực tuyến.

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ó
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
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.