InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

🚧 Get "Modular Code" published in our book

Offen
#529 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

:book: Type - Content Work 2-structured
Vorherrschende Sprache
HTML
Sterne
853
Forks
206
Ø Merge
1 T. 23 Std.
Gemergte PRs (30 T.)
2

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit patterns/1-initial/modular-code.md, lies anschließend die Structured (L2) Requirements in meta/contributor-handbook.md und die Benennungsrichtlinien in meta/pattern-style-guide.md. Überprüfe frühere Diskussionen oder PRs zum Pattern und sieh in pattern-categorization/README.md zur Kategorisierung nach. Die Aufgabe ist abgeschlossen, wenn das Pattern die L2-Erwartungen erfüllt und zur Veröffentlichung im Onlinebuch bereit ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
markdown
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.