InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Improving the "Common Requirements" pattern
Nessuno ha ancora preso questa issue.
- Lingua principale
- HTML
- Stelle
- 853
- Fork
- 206
- Merge medio
- 1g 23h
- PR unite (30g)
- 2
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia leggendo patterns/2-structured/common-requirements.md e la sezione del manuale per i contributor collegata nell’issue, quindi esamina assets/img/CommonReqtsv2.jpg. Suddividi il lavoro nei miglioramenti indicati relativi a pattern, aspetti visivi e validazione; il lavoro è completo quando le modifiche selezionate sono documentate e il pattern contiene le evidenze richieste, incluse due Known Instances aggiuntive se si punta allo stato Validated.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- markdown
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100