Útmutató címkék, projektek és mérföldkövek használatához

  • Cikk

A .NET Docs-csapata gyakran használja a GitHub-címkéket a munkánk rendszerezéséhez. A címkék kombinációinak szűrésével gyorsan a .NET Docs webhely fontos szakaszaira irányíthatjuk a figyelmünket. Szűrhetünk például az architektúra-útmutatók összes nyitott problémájára, amelynek lekérdezése a következő: :issue is:open label:"dotnet-architecture/prod".

GitHub-projektekkel rendszerezzük a futamokat és egyéb célirányos eposzokat. A munka nyomon követésére GitHub-mérföldköveket is használunk. Érdemes úgy felfogni, hogy a projektek a tervezést (problémákat), a mérföldkövek pedig a munkát (lekéréses kérelmeket) szolgálják.

Ez az ütemterv ismerteti, hogyan használjuk ezeket a szervezeti eszközöket, és hivatkozásokat tartalmaz az érdekes területek azonosításához általunk használt szűrőkre.

Címkék

Ha első alkalommal járul hozzá a DotNet/Docs oldalához, kezdje az up-for-grabs (elvihető) problémákkal. Ezek a pontosított hatókörrel rendelkező problémák. Nagyszerű lehetőséget jelentenek az első közreműködésre. Az up-for-grabs nézetből további szűrést végezhet terület és prioritás alapján. A good-first-issue (ideális első probléma) címkével jelöltük azokat a problémákat, amelyek ideálisak a kezdőknek, akik kisebb első hozzájárulást szeretnének tenni.

Címkékkel számos különböző módon osztályozzuk a problémákat:

Minden halmazból (útmutató, kiadás, prioritás) vehet egy-egy címkét, amelyeket kombinálva szűk fókuszt hozhat létre a problémakereséshez.

Egyetlen .NET-útmutatóval kapcsolatos problémák keresése

Az architektúrák e-könyveihez és a .NET-útmutatókhoz címkéket használunk. Minden e-könyv fel van jegyezve a dotnet-architecture/prod címkével. Minden könyv egyedi címkével rendelkezik, amely a következővel /techvégződik: .

Minden .NET-útmutató a utótaggal /prod együtt van feljegyzve, és kék-szürke háttérrel rendelkezik. Itt láthatók az összes .NET-útmutató szűrt problémái.

Más termékcímkék az adattárak közötti területekhez vannak definiálva.

Útmutató egy szakaszának problémáinak megkeresése

A .NET-útmutatók nagy méretűek, így ezek a címkék az útmutató egyes szakaszaival szűkítik a hatókört. A .NET-útmutató minden alterülete fel van jegyezve az /tech utótaggal, és világoskék háttérrel rendelkezik. A címkék közül sok több útmutatóban is megjelenik, míg némelyik csak egyben. Egy adott területre való szűrés után az alábbi címkék egyikével korlátozhatja a problémák hatókörét.

Kiadások

:checkered_flag: Kiadás: sötétsárga

Az egy adott kiadáshoz tartozó problémák a :checkered_flag: Release: előtaggal van feltüntetve, és sötétsárga háttérrel rendelkeznek.

Prioritás

A prioritási címkék mind Pri betűvel vannak jelölve, amelyet egy számjegy követ. A kisebb szám nagyobb prioritást jelent:

  • Pri0 – Kritikus prioritás

    Biztonsági probléma vagy jogilag előírt megfelelőség. Ennek a javítása minden másnál előbbre való.

  • Pri1 – Magas prioritás

    Alapvető fontosságú gyakori helyzetekben. Vagy kiemelten látható hiba magas oldalmegtekintésű oldalon. Ezt a P2-es vagy P3-as munka előtt javítjuk.

  • Pri2 – Közepes prioritás

    Hasznos a gyakori helyzetekben, de nem jelent akadályt. Ha egyszerűen elvégezhető, akkor elvégezzük, vagy betervezzük egy P1-es probléma javítási folyamatába ugyanabban a cikkben.

  • Pri3 – Alacsony prioritás

    Hasznos kevésbé gyakori helyzetekben, triviális javítások gyakori helyzetekben, alacsony oldalmegtekintésű cikkekben vagy elavult technológiákról szólóknál. Nem éri meg az időráfordítást, de közösségi hozzájárulásban elvégezhető. A P3-as problémát lezárhatjuk, ha két hónap alatt nem oldódik meg.

Mi a helyzet a többi címkével?

A tartalommal foglalkozó csapatok számos egyéb címkét használnak a problémák különböző besorolásához. Ha Ön nem a tartalommal foglalkozó csapat tagja, figyelmen kívül hagyhatja ezeket a címkéket.

Projektek

A projektek tervezési célokat szolgálnak, a rangsorolt munka pedig egy Kanban-tábla segítségével van automatizálva. A projekteknek csak GitHub-problémákat szabad tartalmazniuk, lekéréses kérelmeket soha. A projektek abban térnek el a mérföldkövektől, hogy a mérföldkövek csak lekéréses kérelmeket tartalmaznak.

A projekteket kétféleképpen használjuk:

Mérföldkövek

A mérföldkövek általában ugyanazt az elnevezési konvenciót követik, mint a Month YYYY típusú projektek, de különböznek a projektektől. A mérföldköveket az elvégzett munka nyomon követésére használjuk. A mérföldkövek nem tartalmazhatnak problémát (potenciális munkát), hanem kizárólat lekéréses kérelmeket tartalmazhatnak. Az aktuális mérföldkő automatikusan alkalmazva lesz az új lekéréses kérelmekre.