InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Proposal: Renaming "Patlet" to "Summary"

Abierto
#564 7 comentarios 3 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

:gear: Type - Meta
Lenguaje dominante
HTML
Estrellas
853
Forks
206
Merge medio
1 d 23 h
PR fusionados (30 d)
2

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Busca “Patlet” en las plantillas de patrones y en el contenido del repositorio, y revisa la redacción propuesta en el issue. Actualiza el encabezado y la definición para que usen “Summary” y, después, verifica que la terminología antigua ya no esté presente donde se usa la plantilla.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
markdown
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
42/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.