Roadmapa popisků, projektů a milníků

Tým dokumentace k .NET rozsáhle využívá popisky GitHubu k uspořádání a zpřehlednění naší práce. Díky vyfiltrování kombinace popisků se můžeme na webu dokumentace k .NET rychle zaměřit na oddíly, které nás zajímají. Mohli bychom například vyfiltrovat všechny otevřené problémy v průvodcích architekturou pomocí dotazu is:issue is:open label:"dotnet-architecture/prod".

K uspořádání sprintů a dalších procesů (příběhů) zaměřených na cíle používáme projekty GitHubu. Ke sledování práce používáme také milníky GitHubu. Nejlepší je uvažovat projekty pro plánování (problémy) a milníky pro práci (žádosti o přijetí změn).

Tato roadmapa vysvětluje, jak tyto organizační nástroje používáme, a obsahuje odkazy na užitečné filtry, které používáme k vyhledání požadovaných oblastí.

Popisky

Pokud jde o vaši první zkušenost s příspěvky do dotnet/docs, začněte se záležitostmi up-for-grabs. Jde o problémy, které mají konkrétnější zaměření. Představují skvělý způsob, jak udělat svůj první příspěvek. V zobrazení pro up-for-grabs můžete dál filtrovat problémy na základě oblastí a priority. Vhodné problémy pro začátečníky jsme označili popiskem good-first-issue, pokud chcete vyzkoušet menší první příspěvek.

Pomocí popisků rozdělujeme problémy mnoha různými způsoby:

• Příručky .NET a oddíly příručky
• Cílová verze
• Priorita

Můžete zkombinovat popisek z každé sady (příručka, verze, priorita), a zúžit tak prostor pro hledání problémů, na kterých chcete pracovat.

Vyhledání problémů s jedním průvodcem .NET

Popisky používáme pro každou elektronickou knihu (e-knihu) architektury a pro každou příručku .NET. Všechny elektronické knihy jsou označené popiskem dotnet-architecture/prod . Každá kniha má jedinečný popisek, který končí na /tech.

Každý průvodce .NET je označen příponou /prod a má modrošedé pozadí. Tady jsou aktuální problémy vyfiltrované pro jednotlivé příručky .NET.

• .NET Guide – dotnet/prod
• .NET Fundamentals Guide (dříve .NET Standard Guide) – dotnet-fundamentals/prod
• .NET Fundamentals Guide (dříve .NET Core Guide) – dotnet-core/prod
• Průvodce rozhraním .NET Framework – dotnet-framework/prod
• Referenční informace k rozhraní API – dotnet-api/prod
• Průvodce jazykem C# – dotnet-csharp/prod
• Průvodce jazykem F# dotnet-fsharp/prod
• Průvodce jazykem Visual Basic – dotnet-visualbasic/prod
• průvodce ML.NET – dotnet-ml/prod
• Azure .NET SDK – azure-dotnet/prod
• Příručka k .NET for Apache Spark – dotnet-spark/prod
• .NET Desktop Guide – dotnet-desktop/prod

Další popisky produktů jsou definovány pro oblasti, které se nacházejí mezi úložišti.

Vyhledání problémů s jedním oddílem příručky

Příručky .NET jsou velké, takže tyto popisky vymezují rozsah podle oddílu příručky. Každá podoblast průvodce .NET je označena příponou /tech a má světle modré pozadí. Mnohé z těchto popisků platí pro více příruček, ale některé jsou jenom v jedné. Když po filtrování v oblasti přidáte jeden z těchto popisků, rozsah problémů se zúží.

Verze

Problémy označené pro konkrétní verzi jsou označeny předponou :checkered_flag: Release: a mají tmavě žluté pozadí.

Priorita

Popisky priorit Pri jsou všechny následované jednou číslicí. Nižší hodnota znamená vyšší prioritu:

• Pri0 – kritická priorita

  Problém se zabezpečením nebo něco, co je vyžadované zákonem v zájmu dodržování předpisů. Oprava má přednost před vším ostatním.

• Pri1 – vysoká priorita

  Zásadní věc pro typické scénáře. Nebo do očí bijící chyba v článku s velkým počtem zobrazení. Opravě těchto chyb se věnujeme před prací na prioritách P2 a P3.

• Pri2 – střední priorita

  Něco, co by bylo užitečné pro typické scénáře, ale nebrání zcela v práci. Tyto chyby opravíme, pokud to jde udělat snadno a rychle, nebo si je přibereme k opravě problému s prioritou P1 ve stejném článku.

• Pri3 – nízká priorita

  Užitečné věci pro okrajové případy, triviální opravy pro typické scénáře, články s malým počtem zobrazení nebo zastaralé technologie. Na těchto drobnostech nechceme plýtvat časem, ale dáváme je k dispozici, pokud by se jim chtěl věnovat někdo z komunity. Pokud se problému s prioritou P3 nikdo nevěnuje dva měsíce, může být uzavřen.

K čemu jsou ostatní popisky

Týmy obsahu používají mnoho dalších popisků, které slouží ke správě různých klasifikací problémů. Pokud nejste v týmu obsahu, můžete tyto další popisky ignorovat.

Projekty

Projekty jsou určené pro účely plánování, kdy práce s prioritou je automatizována prostřednictvím panelu Kanbanu. Projekty by měly vždy obsahovat jen problémy GitHubu, ne žádosti o přijetí změn. Projekty se liší od milníků tím, že milníky obsahují jen žádosti o přijetí změn.

Projekty používáme dvěma způsoby:

• Typy projektů Month YYYY: Jde o panely Kanbanu pro pracovní plán každého měsíce.
  • Příklady: July 2020, August 2020 a tak dále.
• Dlouhodobé procesy: Slouží k uspořádání úkolů směrem k cíli, kdy práce bude probíhat několik měsíců.
  • Příklady: .NET 5 Wave - Reorganization, .NET Languages (.NET 5 wave) a tak dále.

Milníky

Milníky se obvykle řídí stejnými zásadami vytváření názvů jako projekty Month YYYY, ale od projektů se liší. Milníky používáme ke sledování dokončené práce. Milníky by neměly obsahovat problémy (potenciální práci), ale výhradně jen žádosti o přijetí změn. Aktuální milník se automaticky použije na nové žádosti o přijetí změn.