InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Proposal: Renaming "Patlet" to "Summary"
還沒有人認領這個 Issue。
- 主要語言
- HTML
- 星號
- 853
- 分支
- 206
- 平均合併
- 1 天 23 小時
- 30 天內合併 PR
- 2
描述
In our pattern template we have a section called Patlet. We define it as:
Concise 1-2 sentence description of the problem and solution. Readers may quickly review dozens of these patlets to discover and browse the larger library of patterns. http://wiki.c2.com/?PatLet
However many readers find this confusing, as Patlet is no real word in Englisch, and does not have an intuitive meaning. So while the word Patlet is kind of cute, and maybe fun for some of us (hardcore pattern nerds that is :)), it is not very helpful for the average consumer of our patterns.
Therefore I propose to replace the word Patlet by Summary instead.
Here is how I propose to change the definition in the pattern template.
-## Patlet
+## Summary
-Concise 1-2 sentence description of the problem and solution.
-Readers may quickly review dozens of these patlets to discover and browse the larger library of patterns.
-From http://wiki.c2.com/?PatLet
+Concise summary of the pattern.
+Use the first sentence to describe the **problem**, the second sentence to describe the **solution**.
+Readers may quickly review dozens of these summaries to discover and browse our library of patterns.
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
在模式模板和儲存庫內容中搜尋「Patlet」,並檢視 issue 提議的措辭。更新標題和定義以使用「Summary」,然後確認在使用該模板的地方已不再存在舊術語。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- markdown
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100