Etykiety, projekty i plan kamieni milowych

Zespół zajmujący się dokumentacją platformy .NET w szerokim zakresie korzysta z etykiet usługi GitHub do celów organizacji pracy. Dzięki filtrowaniu według kombinacji etykiet można szybko skupić się na właściwych sekcjach w witrynie dokumentacji platformy .NET. Na przykład możemy filtrować wszystkie otwarte problemy w przewodnikach dotyczących architektury z zapytaniem do: problem: is:open label:"dotnet-architecture/prod".

Projektów usługi GitHub używamy do organizacji przebiegów i innych epik ukierunkowanych na cel. Używamy również kamieni milowych usługi GitHub do śledzenia pracy. Najlepiej jest myśleć o projektach w odniesieniu do planowania (problemów) i o kamieniach milowych w odniesieniu do pracy (żądań ściągnięcia).

W tym planie wyjaśniono, w jaki sposób korzystamy z tych narzędzi organizacyjnych oraz zawarto linki do przydatnych filtrów do odnajdywania obszarów zainteresowania.

Etykiety

Jeśli to Twoje pierwsze doświadczenie związane ze współtworzeniem repozytorium dotnet/docs, rozpocznij od problemów z etykietą up-for-grabs (do wzięcia). Są to problemy, które mają ściślej określony zakres. To doskonały sposób na zdobycie pierwszego doświadczenia. Z widoku „up-for-grabs” można dalej filtrować problemy na podstawie obszarów i priorytetów. Jeśli chcesz spróbować od czegoś mniejszego, użyj repozytorium good-first-issue (dobre na pierwszy problem), w którym zebraliśmy problemy odpowiednie dla osób początkujących.

Za pomocą etykiet klasyfikujemy problemy na różne sposoby:

• Przewodniki platformy .NET oraz sekcje przewodników
• Wersja docelowa
• Priority

Możesz połączyć po jednej etykiecie z każdego zestawu (przewodnik, wersja, priorytet), aby zawęzić zakres wyszukiwania problemów, nad którymi chcesz pracować.

Znajdowanie problemów dotyczących pojedynczego przewodnika platformy .NET

Używamy etykiet dla każdej książki elektronicznej dotyczącej architektury i każdego przewodnika platformy .NET. Wszystkie książki elektroniczne są zanotowane za pomocą etykiety dotnet-architecture/prod . Każda książka ma unikatową etykietę, która kończy się na /tech.

Każdy przewodnik platformy .NET jest zanotowany przy użyciu sufiksu /prod i ma niebieskie szare tło. Oto bieżące problemy przefiltrowane dla każdego z przewodników platformy .NET.

• Przewodnik dla platformy .NET — dotnet/prod
• Przewodnik dotyczący podstaw platformy .NET (dawniej .NET Standard Guide) — dotnet-fundamentals/prod
• Przewodnik podstaw platformy .NET (dawniej .NET Core Guide) — dotnet-core/prod
• przewodnik .NET Framework —dotnet-framework/prod
• Dokumentacja interfejsu API — dotnet-api/prod
• Przewodnik języka C# — dotnet-csharp/prod
• Przewodnik języka F# dotnet-fsharp/prod
• Przewodnik języka Visual Basic — "dotnet-visualbasic/prod
• przewodnik ML.NET — dotnet-ml/prod
• Zestaw SDK platformy .NET platformy Azure — azure-dotnet/prod
• Przewodnik platformy .NET dla platformy Apache Spark — dotnet-spark/prod
• Przewodnik po programie .NET Desktop — dotnet-desktop/prod

Inne etykiety produktów są definiowane dla obszarów obejmujących wiele repozytoriów.

Znajdowanie problemów dotyczących jednej sekcji przewodnika

Przewodniki platformy .NET są duże, a więc te etykiety jeszcze bardziej zawężają zakres sekcji przewodnika. Każdy obszar podrzędny przewodnika platformy .NET jest zanotowany z sufiksem /tech i ma jasnoniebieskie tło. Wiele z tych etykiet ma zastosowanie do wielu przewodników, a inne stosuje się tylko w jednym przewodniku. Po przefiltrowaniu obszaru dodaj jedną z tych etykiet, aby zawęzić zakres problemu.

Wydania

Problemy otagowane pod kątem konkretnego wydania są opatrzone prefiksem :checkered_flag: Release: i mają ciemnożółte tło.

Priorytet

Wszystkie etykiety oznaczające priorytet składają się z litery Pri i jednej cyfry. Im niższa cyfra, tym wyższy priorytet:

• Pri0 — priorytet krytyczny

  Problem z zabezpieczeniami lub zabezpieczenia wymagane do zachowania zgodności z przepisami. Rzucamy wszystko i rozwiązujemy ten problem.

• Pri1 — wysoki priorytet

  Niezbędny w przypadku typowych scenariuszy. Lub wyraźnie widoczny błąd na często oglądanej stronie artykułu. Rozwiązujemy ten problem przed problemami typu P2 lub P3.

• Pri2 — średni priorytet

  Pomocny w przypadku typowych scenariuszy, ale nie blokuje pracy. Rozwiązujemy ten problem, jeśli można to zrobić szybko i łatwo, albo robimy to podczas rozwiązywania problemu typu P1 w tym samym artykule.

• Pri3 — niski priorytet

  Pomocny w przypadku problemów występujących sporadycznie, drobnych poprawek w typowych scenariuszach, rzadko oglądanych stron artykułu lub przestarzałej technologii. Szkoda naszego czasu, ale możliwy do rozwiązania przez współautorów w społeczności. Problem typu P3 może zostać zamknięty, jeśli po 2 miesiącach jest nadal nierozwiązany.

Co znaczą inne etykiety

Jest wiele etykiet używanych przez zespoły zawartości w celu zarządzania różnymi klasyfikacjami problemów. Jeśli nie jesteś członkiem zespołu zawartości, możesz zignorować te etykiety.

Projekty

Projekty są przeznaczone do celów planowania, w przypadku których priorytetowe prace są automatyzowane za pomocą tablicy Kanban. Projekty powinny zawierać tylko problemy w witrynie GitHub, a nie żądania ściągnięcia. Projekty różnią się od kamieni milowych tym, że kamienie milowe zawierają tylko żądania ściągnięcia.

Projektów używamy na dwa sposoby:

• Typy projektów Month YYYY: Są to tablice Kanban dla planu pracy na każdy miesiąc.
  • Przykłady: Lipiec 2020, Sierpień 2020 itd.
• Długotrwałe epiki: Są używane do zorganizowania zadań w ramach realizacji celu, jeśli praca jest zaplanowana na kilka miesięcy.
  • Przykłady: .NET 5 Wave — reorganizacja, Języki .NET (.NET 5 Wave) itd.

Kamienie milowe

Kamienie milowe korzystają zwykle z tej samej konwencji nazewnictwa co projekty Month YYYY, ale różnią się od projektów. Kamieni milowych używamy do śledzenia ukończonych prac. Kamienie milowe nie powinny zawierać problemów (potencjalnej pracy), ale raczej wyłącznie żądania ściągnięcia. Bieżący kamień milowy jest automatycznie stosowany do nowych żądań ściągnięcia.