code-corps / code-corps/code-corps-ember
Write documentation for the Github integration flow
未關閉
documentation
Time: 4 hours
- 主要語言
- JavaScript
- 星號
- 120
- 分支
- 75
- PR 合併指標
- 30 天內沒有已合併 PR
描述
# Problem
We need big picture "how it works" documentation for github integration flow and what it does.
A big chunk of it is explained in #1331 and some of it is additionally explained in #1370
However, it needs to be written in an easier to digest format for developers to refer to when working on integration features.
貢獻指南
研究方向
先閱讀 issue #1331 和 #1370,其中包含現有的 GitHub integration flow 說明。將這些內容整理成一份更容易理解的開發者參考文件,涵蓋該 flow 的運作方式及其作用。當 integration behavior 的文件清楚到足以讓負責開發 integration features 的開發者據此工作時,即表示完成。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- github, javascript
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100