InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

🚧 Get "Modular Code" published in our book

Aperta
#529 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

:book: Type - Content Work 2-structured
Lingua principale
HTML
Stelle
853
Fork
206
Merge medio
1g 23h
PR unite (30g)
2

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia da patterns/1-initial/modular-code.md, quindi leggi gli Structured (L2) Requirements in meta/contributor-handbook.md e le indicazioni sulla nomenclatura in meta/pattern-style-guide.md. Esamina le discussioni o i PR precedenti relativi al pattern e consulta pattern-categorization/README.md per la categorizzazione. Il lavoro è completato quando il pattern soddisfa le aspettative L2 ed è pronto per essere pubblicato nel libro online.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
markdown
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.