InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Improving the "Common Requirements" pattern
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
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.
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
Comece lendo patterns/2-structured/common-requirements.md e a seção do manual do contribuidor vinculada na issue; depois, inspecione assets/img/CommonReqtsv2.jpg. Divida o trabalho nas melhorias de pattern, visuais e de validação listadas; concluído significa que as alterações selecionadas estão documentadas e que o pattern contém as evidências exigidas, incluindo duas Known Instances adicionais caso você esteja buscando o status Validated.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- markdown
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100