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 摘要。