InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Proposal: Renaming "Patlet" to "Summary"

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

还没有人认领这个 Issue。

:gear: Type - Meta
主要语言
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.

贡献指南

打开贡献指南

从这里开始

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

调研方向

在模式模板和仓库内容中搜索“Patlet”,并审阅 issue 提议的措辞。更新标题和定义以使用“Summary”,然后确认在使用该模板的地方已不再存在旧术语。

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

评估

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

把新 issue 发到你的邮箱

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