標籤、專案與里程碑藍圖
.NET 文件小組廣泛使用 GitHub 標籤來管理工作。 藉由篩選標籤組合,即可快速專注於 .NET 文件網站上感興趣的章節。 例如,我們可以篩選至架構指南上所有開啟的問題,並查詢is:issue is:open label:「dotnet-architecture/prod」。
我們會使用 GitHub 專案 \(英文\) 來管理短期衝刺與其他目標導向的 Epic。 我們也會使用 GitHub 里程碑 \(英文\) 來追蹤工作。 最好將專案視為用於規劃 (問題),並將里程碑視為用於工作 (提取要求)。
此藍圖說明如何使用這些管理工具,並包含便利的篩選連結,以便用來尋找感興趣的區域。
標籤
如果這是第一次參與 dotnet/docs,建議您從 up-for-grabs 問題開始。 這些是範圍較集中的問題。 也是您第一次參與的絕佳方式。 從 up-for-grabs 檢視,您可根據區域和優先順序進一步篩選問題。 如果想要在第一次參與時嘗試較不嚴重的問題,我們在 good-first-issue 中列出了適合初學者的不錯問題。
我們使用標籤,以許多不同的方式來分類問題:
您可從每個集合 (指南、版本、優先順序) 合併成一個標籤來建立範圍較窄的焦點,以尋找想要解決的問題。
尋找單一 .NET 指南的問題
我們針對每個架構電子書和每個 .NET 指南使用標籤。 所有電子書都會以 dotnet-architecture/prod 標籤記下。 每本書籍都有以 結尾 /tech
的唯一標籤。
每個 .NET 指南都會加上 /prod
尾碼,並具有藍色灰色的背景。 以下是針對每個 .NET 指南篩選的目前問題。
-
.NET 指南 -
dotnet/prod
-
.NET 基本概念指南 (先前稱為 .NET Standard 指南) -
dotnet-fundamentals/prod
-
.NET 基本概念指南 (先前稱為 .NET Core 指南) -
dotnet-core/prod
-
.NET Framework指南 -
dotnet-framework/prod
-
API 參考 -
dotnet-api/prod
-
C# 指南 -
dotnet-csharp/prod
-
F# 指南-
dotnet-fsharp/prod
- Visual Basic 指南 - 'dotnet-visualbasic/prod
-
ML.NET 指南 -
dotnet-ml/prod
-
Azure .NET SDK -
azure-dotnet/prod
-
適用于 Apache Spark 的 .NET 指南 -
dotnet-spark/prod
-
.NET 桌面指南 -
dotnet-desktop/prod
針對跨存放庫的區域定義其他產品標籤。
尋找指南一節的問題
.NET 指南很大,因此這些標籤會依指南章節進一步限制範圍。 每個 .NET 指南子領域都會加上 /tech
尾碼,並具有淺藍色背景。 這些標籤中有許多適用於多個指南,而其他標籤則只適用於一個指南。 依區域篩選之後,請新增下列其中一個標籤,以進一步限制問題的範圍。
版本
上
針對特定版本標記的問題會以 :checkered_flag: Release:
前置詞來註明,並具有深黃色背景。
優先順序
所有優先順序標籤都是 Pri
後面接著一位數。 數字越低則表示優先順序越高:
Pri0 - 重大優先順序
安全性問題或合規性的法律要求。 我們盡全力修正。
Pri1 - 高優先順序
常見情節的基本項目。 或頁面閱讀次數高的文章中的明顯錯誤。 我們會在 P2 或 P3 工作之前先完成此優先順序的工作。
Pri2 - 中優先順序
對於一般情節有幫助,但不會造成無法執行工作。 如果能以快又簡單的方式修正,我們會執行這些工作,或在於相同的文章中處理 P1 問題時一併處理此優先順序的問題。
Pri3 - 低優先順序
對於邊緣案例、一般情節的非重要性修正、頁面閱讀次數低的文章或過時的技術有幫助。 不值得我們花時間處理,不過可接受社群貢獻。 P3 問題在兩個月後若未處理可以關閉。
那麼其他標籤呢
內容小組使用許多其他標籤來管理不同分類的問題。 如果您不在內容小組上,則可以忽略這些其他標籤。
專案
專案適用於規劃目的,其中具有較高優先順序的工作會透過工作流程看板自動化。 專案只應該包含 GitHub 問題,而「非」提取要求。 專案與里程碑的不同之處,在於里程碑只會包含提取要求。
我們透過兩種方式來使用專案:
-
Month YYYY
專案類型:這些是每月工作計畫的工作流程看板。- 例如 2020 年 7 月 \(英文\)、2020 年 8 月 \(英文\) 等等。
- 長時間執行的 Epic:這些會在工作持續數個月時,用來管理工作達成目標的進度。
- 範例:.NET 5 Wave - 重新組織 \(英文\)、.NET 語言 (.NET 5 wave) \(英文\) 等等。
里程碑
里程碑通常會遵循與專案相同的命名慣例 (Month YYYY
),但其與專案不同。 我們會使用里程碑來追蹤已完成的工作。 里程碑「不應該」包含問題 (潛在工作),而只應包含提取要求。 目前的里程碑會自動套用到新的提取要求。