InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

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

Open
#349 6 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

:book: Type - Content Work (Self-) Hosting
Dominant language
HTML
Stars
853
Forks
206
Avg merge
1d 23h
Merged PRs (30d)
2

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read pattern-categorization/innersource-program-mind-map.md and the documentation in pattern-categorization first, then inspect the existing automation from #348. Add the category and problem statement to the relevant patterns/**/*.md files, consolidate them into the mind map, and confirm the workflow from #348 can run afterward.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.