InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
🚧 Get "Modular Code" published in our book
還沒有人認領這個 Issue。
- 主要語言
- HTML
- 星號
- 853
- 分支
- 206
- 平均合併
- 1 天 23 小時
- 30 天內合併 PR
- 2
描述
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
- Pattern: Modular Code
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.
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從 patterns/1-initial/modular-code.md 開始,接著閱讀 meta/contributor-handbook.md 中的 Structured (L2) Requirements,以及 meta/pattern-style-guide.md 中的命名指南。查看先前關於該 pattern 的討論或 PR,並檢查 pattern-categorization/README.md 以了解分類。完成的標準是該 pattern 符合 L2 預期,並已準備好發佈到線上書籍中。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- markdown
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 5/5
- 預估耗時
- 一週以上
- 活躍度
- 停滯
- 描述清晰度
- 需要釐清
- 新手友好度
- 25/100