InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

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

Ouverte
#349 6 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

:book: Type - Content Work (Self-) Hosting
Langage dominant
HTML
Étoiles
853
Forks
206
Merge moyen
1 j 23 h
PR mergées (30 j)
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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Lisez d’abord pattern-categorization/innersource-program-mind-map.md et la documentation de pattern-categorization, puis examinez l’automatisation existante de #348. Ajoutez la catégorie et l’énoncé du problème aux fichiers patterns/**/*.md concernés, regroupez-les dans la carte mentale et confirmez que le workflow de #348 peut s’exécuter ensuite.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
markdown
Domaine
documentation, tooling
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.