Стратегия: метки, проекты и вехи
Команда по разработке документации .NET активно использует метки GitHub для организации работы. Путем фильтрации по сочетаниям меток мы можем быстро сосредотачиваться на интересующих нас разделах веб-сайта документации по .NET. Например, мы можем отфильтровать все открытые проблемы в руководствах по архитектуре, используя запрос is:issue is:open label:"dotnet-architecture/prod".
Мы используем проекты GitHub для организации спринтов и других целевых ситуаций. Для отслеживания работы мы также используем вехи GitHub. Проще всего запомнить, что проекты относятся к планированию (проблемы), а вехи — к работе (запросы на вытягивание).
В этой стратегии объясняется, как мы используем эти организационные средства, а также есть ссылки на удобные фильтры по некоторым важным областям.
Метки
Если вы впервые участвуете в работе c dotnet/docs, начните со списка проблем up-for-grabs. В него включены проблемы с довольно узкой областью. Это отличный путь для первого вклада в работу. В представлении "up-for-grabs" вы можете отфильтровать проблемы по областям и приоритетам. Проблемы, которые хорошо подходят для начинающих, мы обозначаем меткой good-first-issue, и они помогут вам внести первый небольшой вклад.
Мы используем метки для классификации проблем несколькими способами:
Объединяя метки из каждого набора (руководство, выпуск, приоритет), вы можете создать узкие срезы для поиска проблем, с которыми вы намерены работать.
Поиск проблем по одному руководству .NET
Мы используем метки для каждой из электронных книг по архитектуре и для каждого руководства по .NET. Все электронные книги имеют метку dotnet-architecture/prod. Каждая книга имеет уникальную метку, заканчивающуюся на /tech.
Каждое руководство .NET помечено суффиксом /prod и имеет серо-синий фон. Вот пример списка текущих проблем, которые отфильтрованы по каждому из руководств .NET.
-
Руководство по .NET —
dotnet/prod -
Руководство по основам .NET (ранее — руководство по .NET Standard) —
dotnet-fundamentals/prod -
Руководство по основам .NET (ранее — руководство по .NET Core) —
dotnet-core/prod -
Руководство по .NET Framework —
dotnet-framework/prod -
Справочник по API —
dotnet-api/prod -
Руководство по C# —
dotnet-csharp/prod -
Руководство по F# —
dotnet-fsharp/prod - Руководство по Visual Basic — dotnet-visualbasic/prod
-
Руководство по ML.NET —
dotnet-ml/prod -
Пакет Azure SDK для .NET —
azure-dotnet/prod -
Руководство по .NET для Apache Spark —
dotnet-spark/prod -
Руководство по классическим приложениям .NET —
dotnet-desktop/prod
Другие метки продуктов определяются для областей, охватывающих множество репозиториев.
Поиск проблем по одному разделу руководства
Руководства по .NET достаточно большие, а эти метки позволяют дополнительно ограничить область поиска конкретным разделом руководства. Каждый подраздел руководства .NET Guide помечается суффиксом /tech и имеет голубой фон. Многие из этих меток применяются к нескольким руководствам, а другие — только к одному из них. Применив фильтр по области, добавьте одну из этих меток, чтобы ограничить область поиска проблем.
Выпуски
Проблемы, помеченные для конкретного выпуска, обозначаются префиксом :checkered_flag: Release: и отображаются на темно-желтом фоне.
Приоритет
Метки приоритета содержат символ Pri, за которым следует одна цифра. Чем меньше число, тем выше приоритет.
Pri0 — критический приоритет
Проблема безопасности или необходимость выполнить юридическое требование для обеспечения соответствия. Исправления вносятся прежде любых других.
Pri1 — высокий приоритет
Проблема, которую необходимо устранить для распространенных сценариев. Или бросающаяся в глаза ошибка в статье с большим количеством просмотров страницы. Исправления вносятся перед устранением проблем категорий P2 и P3.
Pri2 — средний приоритет
Проблема, которую полезно устранить для распространенных сценариев, но которая не блокирует работу. Исправления вносятся сразу, если это быстро и просто. Или же они откладываются и вносятся после устранения проблем категории P1 в той же статье.
Рri3 — низкий приоритет
Проблема, которую полезно устранить для пограничных случаев; обычные ошибки, исправляемые для распространенных сценариев; ошибка в статье с малым количеством просмотров страницы; нерекомендуемая технология. Исправлению таких ошибок не уделяется специальное время, они устраняются по мере выявления участниками сообщества. Проблема P3 может быть закрыта, если она не устраняется в течение двух месяцев.
Другие метки
Группы по работе над содержимым используют много других меток для управления разными классификациями проблем. Если вы не входите в такую группу, остальные метки можно смело игнорировать.
Проекты
Проекты предназначены для планирования. При этом приоритетная работа выполняется автоматически с использованием канбан-доски. Проекты должны содержать только проблемы GitHub, но не запросы на вытягивание. Проекты отличаются от вех тем, что вехи содержат только запросы на вытягивание.
Мы используем проекты двумя способами.
- Типы проектов
Month YYYY: это канбан-доски для рабочих планов на каждый месяц.- Примеры: июль 2020 г., август 2020 г. и т. д.
- Долговременные ситуации: используются для упорядочения задач, работа над которыми будет продолжаться несколько месяцев.
- Примеры: .NET 5 Wave — Reorganization, .NET Languages (.NET 5 Wave) и т. д.
Вехи
Вехи обычно следуют соглашению об именовании для проектов Month YYYY, но они отличаются от проектов. Вехи используются для отслеживания завершенной работы. Вехи не должны содержать проблемы (возможная работа), а только запросы на вытягивание. Текущая веха автоматически применяется к новым запросам на вытягивание.