Proposal: Renaming "Patlet" to "Summary"
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 42/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- markdown
- Domain
- documentation
Research direction
Search the pattern templates and repository content for “Patlet” and review the issue’s proposed wording. Update the heading and definition to use “Summary,” then verify that the old terminology is no longer present where the template is used.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- HTML
- Stars
- 853
- Forks
- 206
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 2
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from InnerSourceCommons/InnerSourcePatterns
-
community metrics
InnerSourceCommons/InnerSourcePatterns#935 · 1 assignee ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#934 · 1 assignee ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#922 · 1 assignee ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#921 · 1 assignee ·
-
community metrics
InnerSourceCommons/InnerSourcePatterns#915 · 1 assignee ·
All issues in InnerSourceCommons/InnerSourcePatterns
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 95/100
Git-it-App/git-it-electron#1047 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
neondatabase/website#5944 ·
-
📕documentation
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
db-ux-design-system/core-web#8239 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
libsdl-org/sdlwiki#1008 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100