ラベル、プロジェクト、マイルストーンのロードマップ

  • [アーティクル]

NET docs チームでは、GitHub ラベル を広く利用して、作業を整理しています。 ラベルの組み合わせに基づいてフィルター処理することで、.NET docs Web サイト 上の関心のあるセクションにすばやくフォーカスできます。 たとえば、アーキテクチャ ガイドに含まれているすべての未解決のイシューにフィルターを適用して、次のクエリを使います: is:issue is:open label:"dotnet-architecture/prod"。

私たちは、スプリントやその他のゴール指向のエピックを整理するために、GitHub プロジェクトを使用しています。 また、作業を追跡するために GitHub マイルストーンも使用しています。 プロジェクトは計画用 (issue)、マイルストーンは作業用 (pull request) と考えることをお勧めします。

このロードマップでは、これらの組織ツールの使用方法について説明するほか、目的の領域を見つけるために使用できる便利なフィルターへのリンクも用意されています。

ラベル

これが dotnet/docs に投稿する初めての経験である場合は、up-for-grabs イシューから開始してください。 これらは、より範囲が絞られたイシューです。 これは、最初の投稿を作成するのに最適な方法です。 up-for-grabs ビューから、領域や優先度に基づいてイシューをさらにフィルター処理できます。 最初の投稿を小さくする必要がある場合は、good-first-issue を持つ初心者向けの適切なイシューが特定されています。

ラベルを使用して、さまざまな方法でイシューを分類します。

各セット (ガイド、リリース、優先順位) からのラベルを組み合わせて、範囲を絞って作業対象のイシューを見つけることができます。

1 つの .NET ガイドに関する問題を見つける

アーキテクチャ電子書籍ごとに、および .NET ガイドごとにラベルを使用します。 すべての電子ブックについては、dotnet-architecture/prod 製品ラベルを使用して記載されています。 各書籍には、/tech で終わる一意のラベルがあります。

各 .NET ガイドには /prod サフィックスが付いており、背景は青色です。 .NET ガイドごとにフィルター処理された現在のイシューを以下に示します。

その他の製品ラベルは、リポジトリを越える領域に対して定義されています。

ガイドの 1 つのセクションに関するイシューを見つける

.NET ガイドは大きいので、これらのラベルでは、ガイドのセクションによってスコープがさらに制限されます。 各 .NET ガイドサブエリアには /tech サフィックスが付いており、背景は薄い青色です。 これらのラベルの多くは複数のガイドに適用されますが、他は 1 つのガイドにのみ含まれます。 領域をフィルター処理したら、以下のラベルのいずれかを追加して、イシューの範囲をさらに制限します。

リリース

濃い黄色地に :checkered_flag: Release:

特定のリリースにタグが付けられたイシューには、:checkered_flag: Release: プレフィックスが付いていて、背景は濃い黄色になっています。

優先度

優先順位ラベルはすべて、Pri の後に 1 桁の数字が続きます。 数値が小さいほど優先度が高くなります。

  • Pri0 - 重大な優先度

    セキュリティ イシュー、またはコンプライアンスのために法的に必要です。 他のすべてに優先して修正されます。

  • Pri1 - 高優先度

    一般的なシナリオにおいて不可欠です。 または、ページ ビューが多い記事で非常に目立つエラーです。 これらは P2 や P3 の作業の前に実行されます。

  • Pri2 - 中優先度

    一般的なシナリオにおいて役立ちますが、妨げになるほどではありません。 これらは、すばやく簡単に作業できる場合、または同じ記事内の P1 のイシューに対処するのと同時に実行されます。

  • Pri3 - 低優先度

    特殊なケースで役に立つ、一般的なシナリオにおいてささいな修正である、ページ ビューが少ない記事、または非推奨のテクノロジ。 私たちが作業することはありませんが、コミュニティのメンバーは自由に貢献できます。 P3 のイシューは、2 か月後に対処されていない場合は閉じられる可能性があります。

その他のラベルについて

イシューのさまざまな分類を管理するためにコンテンツ チームが使用するラベルが他にも多数あります。 コンテンツ チームに所属していない場合、そのような他のラベルは無視してかまいません。

プロジェクト

プロジェクトは計画を目的としており、かんばんボードを通じて優先的な作業が自動化されます。 プロジェクトには、GitHub の issue のみを含める必要があります。pull request は "含めません"。 プロジェクトはマイルストーンとは異なります。マイルストーンに含めるのは pull request のみです。

プロジェクトは、次の 2 つの方法で使用します。

  • Month YYYY プロジェクトの種類:これらは、各月の作業計画用のかんばんボードです。
  • 長期間のエピック: これらは、作業が数か月にわたって行われる場合に、ゴールに向けたタスクの整理に使用されます。

マイルストーン

通常、マイルストーンはプロジェクトと同じ名前付け規則 Month YYYY に従いますが、プロジェクトとは異なります。 マイルストーンは、完了した作業を追跡するために使用されます。 マイルストーンには issue (潜在的な作業) を "含めません"。pull request だけを含める必要があります。 現在のマイルストーンは、自動的に新しい pull request に適用されます。