Feuille de route pour les étiquettes, les projets et les jalons

Dans l’équipe de documentation .NET, nous faisons largement appel aux étiquettes GitHub pour organiser notre travail. En filtrant sur des combinaisons d’étiquettes, nous pouvons rapidement nous concentrer sur les sections du site web Documentation .NET qui nous intéressent. Par exemple, nous pouvons filtrer sur l’ensemble des problèmes ouverts dans les guides d’architecture avec une requête is:issue is:open label:"dotnet-architecture/prod".

Nous utilisons des projets GitHub pour organiser des sprints et autres épopées axées sur des objectifs. Nous utilisons également des jalons GitHub pour suivre le travail. Il est préférable d’utiliser les projets pour la planification (problèmes) et les jalons pour le travail (demandes de tirage).

Cette feuille de route examine comment nous utilisons ces outils d’organisation et contient des liens vers des filtres pratiques qui nous permettent de rechercher des zones d’intérêt.

Étiquettes

Si c’est la première fois que vous contribuez à dotnet/docs, commencez par les problèmes up-for-grabs. Ces problèmes ont une étendue plus ciblée. Ils constituent un excellent point de départ pour une première contribution. À partir de la vue up-for-grabs vous pouvez filtrer les problèmes selon leur zone et leur priorité. Les problèmes adaptés aux débutants sont identifiés avec l’étiquette good-first-issue. Utilisez-la si vous souhaitez commencer par une petite contribution.

Nous utilisons des étiquettes pour classifier les problèmes de plusieurs façons :

• Guides .NET et sections d’un guide
• Version cible
• Priorité

Vous pouvez combiner une étiquette de chaque ensemble (guide, version, priorité) pour limiter votre champ de recherche aux problèmes sur lesquels vous souhaitez travailler.

Rechercher les problèmes d’un seul guide .NET

Nous utilisons des étiquettes pour chacun des livres électroniques d’architecture et chaque guide .NET. Tous les ebooks sont signalés avec l’étiquette dotnet-architecture/prod. Chaque livre a une étiquette unique qui se termine par /tech.

Chaque guide .NET a le suffixe /prod et a un arrière-plan bleu-gris. Voici les problèmes actuels filtrés selon les guides .NET.

• Guide .NET - dotnet/prod
• .NET Fundamentals Guide (anciennement .NET Standard Guide) - dotnet-fundamentals/prod
• .NET Fundamentals Guide (anciennement .NET Core Guide) - dotnet-core/prod
• .NET Framework Guide - dotnet-framework/prod
• API Reference - 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 for Apache Spark Guide - dotnet-spark/prod
• .NET Desktop Guide - dotnet-desktop/prod

D’autres étiquettes de produit sont définies pour les domaines qui concernent plusieurs dépôts.

Rechercher les problèmes pour une section d’un guide

Les guides .NET étant volumineux, ces étiquettes permettent de limiter l’étendue à une section d’un guide. Chaque sous-domaine d’un guide .NET a le suffixe /tech et a un arrière-plan bleu clair. Bon nombre d’étiquettes s’appliquent à plusieurs guides, mais certaines ne figurent que dans un seul guide. Après avoir sélectionné une zone à l’aide d’un filtre, ajoutez l’une de ces étiquettes pour limiter encore plus l’étendue des problèmes.

Versions

Les problèmes marqués pour une version spécifique sont signalés par le préfixe :checkered_flag: Release: et ont un arrière-plan jaune foncé.

Priority

Les étiquettes de priorité commencent par la lettre Pri et se terminent par un chiffre. Plus le nombre est petit, plus la priorité est élevée :

• Pri0 – Priorité critique

  Problème de sécurité ou critère légal de conformité. Toutes nos ressources sont consacrées à résoudre ce problème sans délai.

• Pri1 – Priorité élevée

  Élément essentiel pour les scénarios courants ou erreur à forte visibilité sur un article très consulté. Ces points sont traités avant les tâches P2 et P3.

• Pri2 – Priorité moyenne

  Élément utile pour les scénarios courants, mais non bloquant. Ces points sont traités s’ils sont rapides et faciles, ou s’ils concernent le même article qu’un problème P1 en cours de résolution.

• Pri3 – Priorité basse

  Élément utile pour des cas marginaux, correction triviale pour des scénarios courants, article peu consulté ou technologie déconseillée. Ces points ne méritent pas que nous y passions du temps, mais peuvent faire l’objet d’une participation de la communauté. Un problème P3 peut être fermé s’il n’est pas traité au bout de deux mois.

Qu’en est-il des autres étiquettes ?

Les équipes de contenu utilisent bien d’autres étiquettes pour gérer différentes classifications de problèmes. Si vous n’êtes pas membre de l’équipe de contenu, vous pouvez ignorer ces autres étiquettes.

Projets

Les projets sont destinés à des fins de planification, où le travail classé par ordre de priorité est automatisé par le biais d’un tableau Kanban. Les projets ne doivent contenir que des problèmes GitHub, pas des demandes de tirage (pull requests). Les projets sont différents des jalons, dans le sens où les jalons contiennent uniquement des demandes de tirage.

Nous utilisons des projets de deux manières :

• Types de projets Month YYYY : Il s’agit de tableaux Kanban pour le plan de travail de chaque mois.
  • Exemples, Juillet 2020, Août 2020, etc.
• Épopées de longue durée : Nous les utilisons pour organiser les tâches en fonction d’un objectif donné quand le travail s’étale sur plusieurs mois.
  • Exemples : .NET 5 Wave - Réorganisation, Langages .NET (.NET 5 Wave) , etc.

Étapes majeures

Les jalons suivent généralement la même convention d’affectation de noms que les projets Month YYYY, mais ils sont différents des projets. Nous utilisons des jalons pour suivre le travail effectué. Les jalons ne doivent pas contenir des problèmes (travail potentiel), mais uniquement des demandes de tirage. Le jalon actuel est automatiquement appliqué aux nouvelles demandes de tirage.