InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Show category+problem statement used in the mind map in the pattern as well
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- HTML
- Estrellas
- 853
- Forks
- 206
- Merge medio
- 1 d 23 h
- PR fusionados (30 d)
- 2
Descripción
This is a follow-up to the automation work done in #348 related to the pattern mind map.
Currently when a new pattern is written, the pattern author needs to add a reference of the new pattern to pattern-categorization/innersource-program-mind-map.md. Here is more documentation of how the mindmap generation works.
This has some disadvantages:
- easy to forget (because the patten author needs to change 2 files)
- the category and problem statement that is used in the mind map is not visible in the pattern itself i.e. there is no link from one place to the other
Solution idea
- add the category+problem statement to the pattern MD file itself (that way it is already shown in the pattern)
- write a script that consolidates the categories from all
patterns/**/*.mdfiles intoinnersource-program-mind-map.md - after that run the workflow implemented in #348 (would trigger automatically when (2) is done
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Lee primero pattern-categorization/innersource-program-mind-map.md y la documentación de pattern-categorization; después, inspecciona la automatización existente de #348. Añade la categoría y el planteamiento del problema a los archivos patterns/**/*.md pertinentes, consolídalos en el mapa mental y confirma que el workflow de #348 puede ejecutarse después.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- markdown
- Área
- documentation, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100