InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

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

オープン
#349 コメント 6 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

:book: Type - Content Work (Self-) Hosting
主要言語
HTML
スター
853
フォーク
206
平均マージ
1日 23時間
マージ済み PR(30日)
2

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず pattern-categorization/innersource-program-mind-map.md と pattern-categorization 内のドキュメントを読み、その後 #348 の既存の自動化を調べます。関連する patterns/**/*.md ファイルにカテゴリと問題文を追加し、それらをマインドマップに統合して、#348 のワークフローをその後実行できることを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
markdown
領域
documentation, tooling
issue の種類
機能追加
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。