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