Plan de desarrollo de etiquetas, proyectos e hitos
El equipo de documentación de .NET hace un amplio uso de las etiquetas de GitHub para organizar el trabajo. Al filtrar por combinaciones de etiquetas, podemos centrarnos rápidamente en las secciones de interés en el sitio web de documentación de .NET. Por ejemplo, podríamos filtrar todas las incidencias abiertas relativas a las guías de arquitectura con una consulta a is:issue is:open label:"dotnet-architecture/prod".
Se usan proyectos de GitHub para organizar sprints y otras epopeyas orientadas a objetivos. También se usan hitos de GitHub para realizar el seguimiento del trabajo. Es mejor pensar en los proyectos de planeamiento (problemas) y en los hitos de trabajo (solicitudes de incorporación de cambios).
En esta hoja de ruta se explica cómo se usan estas herramientas organizativas y se incluyen vínculos a filtros útiles que se usan para buscar áreas de interés.
Etiquetas
Si esta es la primera experiencia en la contribución a dotnet/docs, empiece con las incidencias up-for-grabs. Se trata de incidencias que tienen un ámbito más específico. Son una excelente manera de realizar la primera contribución. Desde la vista de up-for-grabs, puede filtrar aún más las incidencias en función de las áreas y la prioridad. Hemos identificado incidencias adecuadas para principiantes con la etiqueta good-first-issue (primera incidencia adecuada), en caso de que quiera probar una contribución inicial más pequeña.
Usamos etiquetas para clasificar las incidencias de muchas maneras diferentes:
Puede combinar una etiqueta de cada conjunto (guía, versión, prioridad) para crear un enfoque centrado a fin de buscar las incidencias en las que quiere trabajar.
Búsqueda de incidencias sobre una única guía de .NET
Usamos etiquetas para cada uno de los libros electrónicos de la arquitectura y para cada guía de .NET. Todos los libros electrónicos incluyen la etiqueta dotnet-architecture/prod. Cada libro tiene una etiqueta única que termina en /tech.
Cada guía de .NET incluye el sufijo /prod y tiene un fondo de color azul grisáceo. Estas son las incidencias actuales filtradas para cada una de las guías de .NET.
-
Guía de .NET:
dotnet/prod -
Guía sobre los aspectos básicos de .NET (antes, Guía de .NET Standard):
dotnet-fundamentals/prod -
Guía sobre los aspectos básicos de .NET (antes, Guía de .NET Core):
dotnet-core/prod -
Guía de .NET Framework:
dotnet-framework/prod -
Referencia de API:
dotnet-api/prod -
Guía de C#:
dotnet-csharp/prod -
Guía de F#:
dotnet-fsharp/prod - Guía de Visual Basic: `dotnet-visualbasic/prod
-
Guía de ML.NET:
dotnet-ml/prod -
SDK de .NET para Azure:
azure-dotnet/prod -
Guía de .NET para Apache Spark:
dotnet-spark/prod -
Guía de .NET para escritorio:
dotnet-desktop/prod
Para las áreas que abarcan varios repositorios, se han definido otras etiquetas de producto.
Búsqueda de incidencias para una sección de una guía
Las guías de .NET son grandes, por lo que estas etiquetas limitan aún más el ámbito a una sección de una guía. Cada subárea de las guías de .NET incluye el sufijo /tech y tiene un fondo de color azul claro. Muchas de estas etiquetas se aplican a varias guías, mientras que otras se encuentran en una sola. Después de filtrar por un área, agregue una de estas etiquetas para limitar todavía más el ámbito de las incidencias.
Versiones
Las incidencias etiquetadas para una versión específica se anotan con el prefijo :checkered_flag: Release: y tienen un fondo de color amarillo oscuro.
Priority
Todas las etiquetas de prioridad son Pri, seguidas de un solo dígito. Los números más bajos son de mayor prioridad:
Pri0: prioridad crítica
Incidencia de seguridad o exigencia legal por motivos de cumplimiento. Abandonaremos todo lo que estemos haciendo para corregirla.
Pri1: prioridad alta
Esencial en escenarios comunes. O bien, error muy visible en artículo de vista de página de nivel alto. La resolveremos antes de trabajar con P2 o P3.
Pri2: prioridad media
Sirve de ayuda en escenarios comunes, pero no es un impedimento. La resolveremos si es rápido y fácil o la corregiremos mientras resolvemos una incidencia P1 en el mismo artículo.
Pri3: prioridad baja
Sirve de ayuda en casos extremos, correcciones menores en escenarios comunes, artículo de vista de página de nivel bajo o tecnología en desuso. No merece la pena perder nuestro tiempo, pero está disponible para la contribución de la comunidad. Una incidencia P3 puede cerrarse si no se soluciona transcurridos dos meses.
¿Qué ocurre con las demás etiquetas?
Los equipos de contenido usan muchas otras etiquetas para administrar distintas clasificaciones de incidencias. Si no está en el equipo de contenido, puede omitir estas otras etiquetas.
Proyectos
Los proyectos están pensados para fines de planeamiento, donde el trabajo con prioridad se automatiza mediante un panel Kanban. Los proyectos solo deben contener incidencias de GitHub, y no solicitudes de incorporación de cambios. Los proyectos difieren de los hitos por el hecho de que estos últimos solo contienen solicitudes de incorporación de cambios.
Los proyectos se usan de dos maneras:
- Tipos de proyectos
Month YYYY: se trata de paneles Kanban para el plan de trabajo de cada mes.- Ejemplos: julio de 2020, agosto de 2020, etc.
- Epopeyas de ejecución prolongada: se usan para organizar las tareas hacia un objetivo cuando el trabajo se va a realizar durante varios meses.
- Ejemplos: .NET 5 Wave - Reorganización, Lenguajes de .NET (.NET 5 Wave) , etc.
Hitos
Los hitos suelen seguir la misma convención de nomenclatura que los proyectos Month YYYY, pero hay diferencias entre ellos. Los hitos se usan para realizar el seguimiento del trabajo completado. Los hitos no deben contener incidencias (trabajo potencial), sino solicitudes de incorporación de cambios exclusivamente. El hito actual se aplica automáticamente a las nuevas solicitudes de incorporación de cambios.