Översikt över etiketter, projekt och milstolpar

Teamet bakom .NET-dokumentationen använder GitHub-etiketter i hög utsträckning för att organisera vårt arbete. Genom att filtrera på kombinationer av etiketter kan vi snabbt fokusera på intressanta avsnitt på webbplatsen för .NET-dokument. Vi kan till exempel filtrera efter alla öppna problem i arkitekturguiderna med en fråga till is:issue is:open label:"dotnet-architecture/prod".

Vi använder GitHub-projekt för att organisera sprinter och andra målorienterade epics. Vi använder även GitHub-milstolpar för att spåra arbete. Det är bäst att tänka på projekt för planering (problem) och milstolpar för arbete (pull-begäranden).

Den här översikten förklarar hur vi använder organisationsverktygen och innehåller länkar till praktiska filter som vi använder för att hitta intressanta områden.

Etiketter

Om det här är första gången som du bidrar till dotnet/dokument, börjar du med först-till-kvarn-problemen. Det här är problem som har en mer fokuserad omfattning. De är ett utmärkt sätt att göra ditt första bidrag. Från vyn för först-till-kvarn-problem kan du sedan filtrera problem baserat på områden och prioritet. Vi har identifierat lämpliga problem för nybörjare som bra första problem om du vill prova med ett mindre bidrag första gången.

Vi använder etiketter för att klassificera problem på många olika sätt:

• .NET-guider och avsnitt i en guide.
• Målversion
• Priority

Du kan kombinera en etikett från varje uppsättning (guide, utgåva, prioritet) för att skapa en smal fokusering och hitta problem som du vill arbeta med.

Hitta problem med en enda .NET-guide

Vi använder etiketter för var och en av e-böckerna om arkitektur och för varje .NET-guide. Alla e-böcker anges med etiketten dotnet-architecture/prod . Varje bok har en unik etikett som slutar med /tech.

Varje .NET-guide anges med suffixet /prod och har en blågrå bakgrund. Här filtreras aktuella ämnen för varje guide om .NET.

• .NET-guide – dotnet/prod
• .NET Fundamentals Guide (tidigare .NET Standard Guide) - dotnet-fundamentals/prod
• .NET Fundamentals Guide (tidigare .NET Core Guide) - dotnet-core/prod
• .NET Framework guide -dotnet-framework/prod
• API-referens – dotnet-api/prod
• C#-guide – dotnet-csharp/prod
• F# Guide- dotnet-fsharp/prod
• Visual Basic Guide – 'dotnet-visualbasic/prod
• ML.NET guide - dotnet-ml/prod
• Azure .NET SDK – azure-dotnet/prod
• .NET för Apache Spark-guide – dotnet-spark/prod
• .NET Desktop Guide – dotnet-desktop/prod

Andra produktetiketter definieras för områden som korsar lagringsplatser.

Hitta problem för ett avsnitt i en guide

.NET-guiderna är stora, så de här etiketterna begränsar omfånget ytterligare genom ett avsnitt i en guide. Varje .NET Guide-underområde anges med suffixet /tech och har en ljusblå bakgrund. Många av de här etiketterna gäller för flera guider, medan andra bara förekommer i en guide. När du har filtrerat på ett område lägger du till någon av dessa etiketter för att ytterligare begränsa problemomfånget.

Versioner

Problem som taggats för en specifik version anges med prefixet :checkered_flag: Release: och har en mörkgul bakgrund.

Prioritet

Alla prioritetsetiketter anges som Pri följt av en siffra. Lägre nummer har högre prioritet:

• Pri0 – Kritisk prioritet

  Säkerhetshot eller krävs juridiskt för efterlevnad. Vi släpper allt annat för att åtgärda detta.

• Pri1 – Hög prioritet

  Viktigt för vanliga scenarier. Eller mycket synligt fel på artikel med hög sidvisning. Vi gör detta innan P2 eller P3 fungerar.

• Pri2 – Medelhög prioritet

  Användbart för vanliga scenarier med blockerar inte. Vi gör detta om det går snabbt och enkelt, eller passar på att göra det när vi åtgärdar ett P1-problem i samma artikel.

• Pri3 – Låg prioritet

  Användbart för gränsärenden, enkla korrigeringar för vanliga scenarier, artikel med lågt antal sidvisningar eller inaktuell teknik. Inte värt vår tid men först till kvarn för communitybidrag. Ett P3-problem kan avslutas om det inte har åtgärdats efter två månader.

Vad gäller för andra etiketter

Det finns många andra etiketter som innehållsteamen använder för att hantera olika klassificeringar av problem. Om du inte ingår i innehållsgruppen kan du ignorera dessa etiketter.

Projekt

Projekt är avsedda för planeringsändamål, där prioriterat arbete automatiseras via en Kanban-tavla. Projekt bör bara innehålla GitHub-problem, inte pull-begäranden. Projekt skiljer sig från milstolpar, där milstolparna bara innehåller pull-begäranden.

Vi använder projekt på två sätt:

• Month YYYY projekttyper: Det här är Kanban-tavlor för respektive månads arbetsplan.
  • Exempel juli 2020, augusti 2020 och så vidare.
• Tidskrävande epic-objekt: Används för att organisera aktiviteter mot ett mål när arbetet sker under flera månader.
  • Exempel: .NET 5 Wave – omorganisering, .NET-språk (.NET 5 Wave) och så vidare.

Milstolpar

Milstolpar följer vanligtvis samma namngivningskonvention för projekt Month YYYY, men de skiljer sig från projekt. Vi använder milstolpar för att spåra slutfört arbete. Milstolpar bör inte innehålla problem (potentiellt arbete), men de innehåller i stället uteslutande pull-begäranden. Den aktuella milstolpen används automatiskt för nya pull-begäranden.