InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Show category+problem statement used in the mind map in the pattern as well
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- HTML
- Estrelas
- 853
- Forks
- 206
- Merge médio
- 1d 23h
- PRs com merge (30d)
- 2
Descrição
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
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Leia primeiro pattern-categorization/innersource-program-mind-map.md e a documentação em pattern-categorization e, em seguida, inspecione a automação existente de #348. Adicione a categoria e a descrição do problema aos arquivos patterns/**/*.md relevantes, consolide-os no mapa mental e confirme que o workflow de #348 pode ser executado depois.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- markdown
- Domínio
- documentation, tooling
- Tipo de issue
- Funcionalidade
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100