InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Improving the "Common Requirements" pattern
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
Some ideas for improving the Common Requirements pattern:
- Improve the Patlet - escpecially describe how the Solution is improving upon the Problem
- Break up Forces into bullets - so that readers can check more easily if these forces apply in their orgs as well
- Decide what to do with the Resulting Context: It currently focuses mostly on other related challenges that may need to be solved after this pattern is in place. However it lacks explanation of how this pattern has helped to address the problem i.e. how can people confirm "did it work"?
- improving the visual e.g. by creating a new version digitally (so no scan), and explaining in the pattern what that visual illustrates
To even level the pattern up to Validated, we would have to find 2 more Known Instances of orgs using this pattern. As this might be hard to do, it could be achieved in multiple steps (and PRs) over time.
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
Empieza leyendo patterns/2-structured/common-requirements.md y la sección del manual del contribuidor enlazada en el issue; después, inspecciona assets/img/CommonReqtsv2.jpg. Divide el trabajo en las mejoras de patrón, visuales y de validación indicadas; terminado significa que los cambios seleccionados están documentados y que el patrón contiene las evidencias requeridas, incluidas dos Known Instances adicionales si se busca el estado Validated.
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
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100