InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Help pattern authors with Context + Forces
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
Pattern authors often struggle with filling in the Context + Forces sections of our pattern template.
Could we give them more guidance on how to fill in Context + Forces?
@NewMexicoKid you are dropping nuggets of wisdom about these sections in your reviews sometimes (as in the example below). Could you help us extend the pattern template with further instructions, especially around these two sections?
Example of "nuggets of wisdom"
Whenever possible, forces should be stated in a way that indicates the trade-offs (which can hint at the levers by which one can react to a given force).
So if Product Owners are reluctant to be more collaborative and transparent, what is motivating them to do so? (Is it a cultural tendency to secrecy to protect proprietary information to gain a strategic advantage? If so, then is it a matter of noting which information needs to be protected vs. which info, when shared, can result in compensating advantages?)
Originally posted by @NewMexicoKid in https://github.com/InnerSourceCommons/InnerSourcePatterns/pull/417#discussion_r878929031
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
Localize o template de pattern referenciado pela issue e revise as orientações existentes sobre Context e Forces. Compare o template com as recomendações de revisão citadas e atualize essas seções com instruções mais claras; considera-se concluído quando os autores de patterns tiverem orientações práticas no template.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Domínio
- content, documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100