InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

Show category+problem statement used in the mind map in the pattern as well

Offen
#349 6 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

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

  1. add the category+problem statement to the pattern MD file itself (that way it is already shown in the pattern)
  2. write a script that consolidates the categories from all patterns/**/*.md files into innersource-program-mind-map.md
  3. after that run the workflow implemented in #348 (would trigger automatically when (2) is done

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

Lies pattern-categorization/innersource-program-mind-map.md und zuerst die Dokumentation in pattern-categorization, und untersuche anschließend die bestehende Automatisierung aus #348. Füge die Kategorie und die Problembeschreibung zu den relevanten patterns/**/*.md-Dateien hinzu, führe sie in der Mindmap zusammen und bestätige, dass der Workflow aus #348 anschließend ausgeführt werden kann.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
markdown
Bereich
documentation, tooling
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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