InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

🚧 Get "Modular Code" published in our book

Ouverte
#529 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

WIP: I am drafting this issue to describe the work required to level up a given pattern from Initial (Level 1) to Structured (Level 2). I am using this pattern as an example for this. I am hoping that later we can extract generalizable points into a GitHub issue template, that we can use whenever we want to do such "leveling up" for other patterns.

Meta

Goal

Improve the given pattern to get it published in our InnerSource patterns online book at patterns.innersourcecommons.org.

Once published in the book, the pattern can be discovered more easily by people looking to improve their InnerSource practices. The upside for pattern authors and their orgs is an increased brand recognition, and positioning themselves as an InnerSource thought leader.

Getting Started

  • We recommend that you review the Structured (L2) Requirements to understand the quality expectations we have set for the patterns in our book.
  • Double check if there were any open discussion points in previous PRs about this pattern. You might built on these discussion points to improve the pattern further.

Possible Improvements

Here some examples of possible activities that might improve this pattern:

  • Since publishing this pattern as Initial, did you make any new experiences while applying this pattern?
  • Once we have published the pattern in the book it becomes harder to change the title (and filename) without breaking URLs. Therefore we recommend to confirm one more time if you are happy with the title of the pattern (and its file name). For further tips see Naming Patterns.
  • Are there any other L2/Structured patterns that you could link to from within this pattern?
  • Are there any resources that you could link to that would help to either validate your pattern, or make it easier for the readers to understand it? Please confirm that these are resources that you trust.
  • Determine to which phase of the InnerSource Program Mind Map the pattern should be added to (add it to at least one phase). This makes it easier for readers to discover your pattern as well.
  • (optional) Do you know any other organizations using this pattern? Getting them to contribute their knowledge to the pattern and adding them as a Known Instance significantly hardens the pattern. Activities around this can also happen in a new issue/PR.

The above are just some suggestions.

You are the expert on your pattern, so please make your own judgement calls about how your pattern can be improved.

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 patterns/1-initial/modular-code.md, puis lisez les Structured (L2) Requirements dans meta/contributor-handbook.md et les recommandations de nommage dans meta/pattern-style-guide.md. Consultez les discussions ou PRs précédents concernant le pattern, et consultez pattern-categorization/README.md pour la catégorisation. C’est terminé lorsque le pattern répond aux attentes de L2 et est prêt à être publié dans le livre en ligne.

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é
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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