InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Improving the "Common Requirements" pattern

Ouverte
#389 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

:book: Type - Content Work 2-structured
Langage dominant
HTML
Étoiles
853
Forks
206
Merge moyen
1 j 23 h
PR mergées (30 j)
2

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par lire patterns/2-structured/common-requirements.md et la section du guide du contributeur liée dans l’issue, puis examinez assets/img/CommonReqtsv2.jpg. Répartissez le travail entre les améliorations de pattern, visuelles et de validation indiquées ; le travail est considéré comme terminé lorsque les changements sélectionnés sont documentés et que le pattern contient les éléments de preuve requis, notamment deux Known Instances supplémentaires si le statut Validated est visé.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
markdown
Domaine
documentation
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.