InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Improving the "Common Requirements" pattern

未关闭
#389 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

:book: Type - Content Work 2-structured
主要语言
HTML
星标
853
派生
206
平均合并
1 天 23 小时
30 天内合并 PR
2

描述

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.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

先阅读 patterns/2-structured/common-requirements.md 以及 issue 中链接的 contributor handbook 章节,然后检查 assets/img/CommonReqtsv2.jpg。将工作分解为所列出的 pattern、视觉和验证改进;完成意味着所选更改已记录,并且该 pattern 包含所需的证据,如果要追求 Validated 状态,还包括另外两个 Known Instances。

由索引模型根据 Issue 内容生成。

评估

技术栈
markdown
领域
documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。