InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Proposal: Renaming "Patlet" to "Summary"
Nessuno ha ancora preso questa issue.
- Lingua principale
- HTML
- Stelle
- 853
- Fork
- 206
- Merge medio
- 1g 23h
- PR unite (30g)
- 2
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Cerca “Patlet” nei template dei pattern e nei contenuti del repository, quindi esamina la formulazione proposta nell’issue. Aggiorna l’intestazione e la definizione per usare “Summary”, quindi verifica che la terminologia precedente non sia più presente nei punti in cui viene usato il template.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- markdown
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 42/100