InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns
Show category+problem statement used in the mind map in the pattern as well
Nessuno ha ancora preso questa issue.
- Lingua principale
- HTML
- Stelle
- 853
- Fork
- 206
- Merge medio
- 1g 23h
- PR unite (30g)
- 2
Descrizione
This is a follow-up to the automation work done in #348 related to the pattern mind map.
Currently when a new pattern is written, the pattern author needs to add a reference of the new pattern to pattern-categorization/innersource-program-mind-map.md. Here is more documentation of how the mindmap generation works.
This has some disadvantages:
- easy to forget (because the patten author needs to change 2 files)
- the category and problem statement that is used in the mind map is not visible in the pattern itself i.e. there is no link from one place to the other
Solution idea
- add the category+problem statement to the pattern MD file itself (that way it is already shown in the pattern)
- write a script that consolidates the categories from all
patterns/**/*.mdfiles intoinnersource-program-mind-map.md - after that run the workflow implemented in #348 (would trigger automatically when (2) is done
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
Leggi prima pattern-categorization/innersource-program-mind-map.md e la documentazione in pattern-categorization, quindi esamina l’automazione esistente di #348. Aggiungi la categoria e la descrizione del problema ai file patterns/**/*.md pertinenti, consolidali nella mappa mentale e conferma che il workflow di #348 possa essere eseguito successivamente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- markdown
- Ambito
- documentation, tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100