InnerSourceCommons / InnerSourceCommons/InnerSourcePatterns

New content type - Scenario

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

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

主要言語
HTML
スター
853
フォーク
206
平均マージ
1日 23時間
マージ済み PR(30日)
2

説明

In two recent conversations in PRs, we were unsure which content should go into which of our existing patterns. We ended up creating comparisons between the related patterns, partly supported by AI. These proved to be super helpful to figure out what the core focus of each of the existing patterns is, and how new patterns can add new insights to "fill the gaps" between the existing patterns.

Besides being useful for pattern maintainers in the context of a PR, I wonder if such overviews/comparisons could also be useful for regular readers of our patterns, to figure out how the patterns are related to each other.

Such a write-up does not feel like a pattern but rather like a new content type of our InnerSource patterns book. If I had to give such write-ups a name I might call it "scenario", "use case", or even just "article".

Example Scenarios

We could publish a scenario called "Enable project reuse". In that scenario we would incorporate this comparison table, and point to patterns immediately related to the scenario.

Recent conversations with pattern comparisons

  • comparison of patterns related to the Governance Levels pattern - see comment / #765
  • comparison of patterns related to the Discover your InnerSource - see comment / #780

Related

Two other things that this idea reminds me of:

  • @rrrutledge had pitched the idea of an InnerSource handbook some time ago. The handbook also wanted to use a format that was less strict than our pattern format, while still reusing or referencing a lot of the content that our patterns provide.
  • Our mindmap is already grouping the patterns into smaller groups. For each of these groups one might publish a scenario article. e.g. the "Discovery Challenges" group already contains some of the patterns that might be used in the "Enable project reuse" example above.

Out of scope (for now)

The new content type that we are exploring here could be integrated into one or multiple of our existing ISC assets. e.g. this could fit into the InnerSource Patterns book but also in the Learning Path, or even the Managing InnerSource Projects book.

I think that it would be best to first discuss which content would be helpful for the readers, and how hard it would be to generate such content (we have very few contributors, so I don't want to create an idea that cannot be implemented anyways because it requires too much effort).

Once that is clear, we could discuss again where that content should be published. It could even be integrated into multiple ISC assets.

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

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

はじめの一歩

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

調査の方向性

まず、PR #765 と #780 からリンクされているパターン比較を確認し、次に pattern-categorization/innersource-program-mind-map.png のリファレンスを調べてください。この作業はまだ特定のファイルや実装パスにスコープが定められていません。完了には、シナリオのコンテンツタイプ、その有用な範囲、および公開先について合意する必要があります。

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

評価

領域
content, documentation
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
20/100

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

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