Mapa de objetivos de etiquetas, projetos e marcos

A equipa de documentação do .NET faz uma utilização extensiva das etiquetas do GitHub para organizar o nosso trabalho. Ao filtrar as combinações de etiquetas, podemos rapidamente focar-nos em secções de interesse no site da documentação do .NET. Por exemplo, podemos filtrar todos os problemas abertos nos guias de arquitetura com uma consulta para is:issue is:open label:"dotnet-architecture/prod".

Utilizamos os projetos do GitHub para organizar sprints e outros épicos orientados para objetivos. Utilizamos também os marcos do GitHub para controlar o trabalho. Em geral, podemos considerar que os projetos se destinam ao planeamento (problemas) e os marcos ao trabalho (pedidos Pull).

Este mapa de objetivos explica como utilizamos estas ferramentas organizacionais e tem ligações a filtros práticos que utilizamos para encontrar áreas de interesse.

Etiquetas

Se esta é a sua primeira experiência a contribuir para dotnet/docs, comece com os problemas up-for-grabs. Estes são problemas com um âmbito mais direcionado. São uma ótima maneira de efetuar a sua primeira contribuição. A partir da vista de up-for-grabs, pode filtrar ainda mais problemas baseados em áreas e prioridade. Identificámos bons problemas para principiantes com o good-first-issue, se quiser experimentar uma primeira contribuição mais pequena.

Utilizamos etiquetas para classificar os problemas de muitas maneiras diferentes:

• Guias do .NET e secções de um guia.
• Versão de destino
• Priority

Pode combinar uma etiqueta de cada conjunto (guia, versão, prioridade) para criar um foco restrito para encontrar problemas nos quais pretende trabalhar.

Encontrar problemas para um único guia .NET

Utilizamos etiquetas para cada um dos e-books de arquitetura e para cada Guia de .NET. Todos os ebooks são anotados com a etiqueta dotnet-architecture/prod . Cada livro tem uma etiqueta exclusiva que termina com /tech.

Cada Guia .NET é anotado com o /prod sufixo e tem um fundo azul-cinzento. Aqui estão os problemas atuais filtrados para cada um dos guias de .NET.

• Guia .NET - dotnet/prod
• Guia de Noções Básicas do .NET (anteriormente denominado Guia Padrão do .NET) – dotnet-fundamentals/prod
• Guia de Noções Básicas do .NET (anteriormente denominado Guia do .NET Core) – dotnet-core/prod
• Guia de .NET Framework -dotnet-framework/prod
• Referência da API - dotnet-api/prod
• Guia de C# - dotnet-csharp/prod
• Guia F# - dotnet-fsharp/prod
• Guia do Visual Basic - 'dotnet-visualbasic/prod
• Guia de ML.NET - dotnet-ml/prod
• SDK .NET do Azure - azure-dotnet/prod
• Guia do .NET para Apache Spark - dotnet-spark/prod
• Guia de Ambiente de Trabalho do .NET - dotnet-desktop/prod

Outras etiquetas de produto são definidas para áreas que cruzam repositórios.

Encontrar problemas para uma secção de um guia

Os guias de .NET são grandes, pelo que estas etiquetas limitam ainda mais o âmbito por uma secção de um guia. Cada subárea do Guia .NET é anotado com o /tech sufixo e tem um fundo azul claro. Muitas destas etiquetas aplicam-se a múltiplos guias, enquanto outras estão em apenas um guia. Depois de filtrar uma área, adicione uma destas etiquetas para limitar ainda mais o âmbito dos problemas.

Versões

Os problemas etiquetados para uma versão específica são assinalados com o prefixo :checkered_flag: Release: e têm um fundo amarelo escuro.

Prioridade

As etiquetas de prioridade são todas seguidas Pri por um único dígito. Os números mais baixos indicam prioridade mais elevada:

• Pri0 - Prioridade crítica

  Problema de segurança ou legalmente necessário por motivos de conformidade. Damos prioridade à sua correção relativamente a tudo o resto.

• Pri1 - Alta prioridade

  Essencial para cenários comuns. Ou erro altamente visível num artigo numa página de elevada visibilidade. Damos prioridade face ao P2 ou P3.

• Pri2 - Prioridade média

  Útil para cenários comuns, mas não bloqueador. Resolvemos estes problemas se forem fáceis e rápidos ou encaixámo-los ao resolver um problema P1 no mesmo artigo.

• Pri3 - Prioridade baixa

  Útil para casos marginais, correções triviais para cenários comuns, artigo em página de baixa visibilidade ou tecnologia preterida. Não merece o nosso tempo, mas está disponível para contribuição por parte da comunidade. Um problema P3 pode ser fechado se não for resolvido após dois meses.

E as outras etiquetas?

Existem muitas outras etiquetas utilizadas pelas equipas de conteúdo para gerir diferentes classificações de problemas. Se não estiver na equipa de conteúdo, pode ignorar estas outras etiquetas.

Projetos

Os projetos destinam-se a fins de planeamento, em que o trabalho priorizado é automatizado através de um painel Kanban. Os projetos devem conter apenas problemas do GitHub, não pedidos Pull. Os projetos diferem dos marcos, sendo que os últimos contêm apenas pedidos Pull.

Utilizamos os projetos de duas formas:

• Month YYYY tipos de projetos: Estes são painéis Kanban para o plano de trabalho de cada mês.
  • Exemplos: Julho de 2020, Agosto de 2020 e assim por diante.
• Épicos de longa duração: Estes são utilizados para organizar tarefas para um objetivo quando o trabalho ocorrerá ao longo de vários meses.
  • Exemplos: Wave .NET 5 – Reorganização, Linguagens .NET (wave .NET 5) e assim por diante.

Marcos

Normalmente, os marcos seguem a mesma convenção de nomenclatura dos projetos Month YYYY, mas são diferentes destes. Utilizamos os marcos para controlar o trabalho concluído. Os marcos não devem conter problemas (potencial trabalho), mas apenas pedidos Pull. O marco atual é aplicado automaticamente a novos pedidos Pull.