Эта страница описывает систему меток (label), которая используется в репозитории habitica на GitHub для сбора ишью для сайта Habitica.
Введение[]
Для каждого пул-реквеста (pull request, PR) назначается одна метка status.
Для каждой ишью (issue) назначается:
- одна метка
priority - одна или иногда две метки
status(метка help wanted также относится к этой метке) - одна или несколько меток
section - (необязательно) одна или несколько меток
type, если потребуется
Состояние пул-реквеста[]
Для каждого пул-реквеста (PR) назначается одна метка status для обозначения на какой стадии он сейчас находится. Она изменяется администраторами по мере продвижения PR по стадиям.
status: pr: ready for review - ожидается, когда администраторы Habitica рассмотрят его.
status: pr: with author: needs tests - ожидается, когда автор напишет тесты.
status: pr: with author: needs work - ожидается, когда автор выполнит другую работу, отличную от тестов (или другую работу, а также напишет тесты).
status: pr: merged in develop; deploy pending - используется администраторами, чтобы помочь им управлять циклом выпуска.
status: pr: tested and approved; merge pending - используется администраторами, чтобы помочь им управлять циклом выпуска.
status: needs reply - применяется к PR или ишью, когда ожидается ответ на вопрос. Например, администратор интересуется как продвигается работа над PR, или когда автор спросил что-то у администратора, тогда используется эта метка до тех пор, пока автор/администратор не ответит. Это позволяет администраторам легко отслеживать PR или ишью, которым может потребоваться дальнейшее наблюдение.
Состояние ишью[]
Для каждой ишью назначается одна метка status для обозначения на какой стадии находится её разрешение. Она будет изменяться по мере изменения решения ишью.
help wanted - любой участник может начать работать над этой ишью, но когда вы решите сделать это, для начала оставьте в ней комментарий! После этого мы назначим ей метку in progress, чтобы другие участники не пытались над ней работать. (Ранее эта метка называлась status: issue: help welcome now, но метка help wanted является стандартной на GitHub, поэтому теперь используется она.)
status: issue: in progress - ишью, над которой в данный момент работает автор.
status: issue: need investigation - проблемы, которые пока непонятно как решить. Если у вас есть идеи по одной из таких ишью, или вы знаете как решить её и хотите поработать над ней, то оставьте в ней комментарий!
status: issue: suggestion-discussion - ишью, которая в данный момент обсуждается, чтобы понять как её решить. Обратите внимание, что игроки не должны предлагать новые функции через GitHub; вместо этого используйте доску на Trello доступную через «Помощь» > «Предложить новую функцию» из меню сайта Habitica.
status: issue: on hold - ишью, над которой нельзя работать, пока не будет решено что-то другое (напр., пока не будет исправлена другая ишью или пока проект не будет завершен).
status: issue: on hold - needs design - ишью, над которой нельзя работать, пока для неё не будет создан визуальный дизайн.
status: needs reply - применяется к PR или ишью, когда ожидается ответ на вопрос. Например, администратор интересуется как продвигается работа над PR, или когда автор спросил что-то у администратора, тогда используется эта метка до тех пор, пока автор/администратор не ответит. Это позволяет администраторам легко отслеживать PR или ишью, которым может потребоваться дальнейшее наблюдение.
Приоритет ишью[]
Для каждой ишью назначается одна метка priority для обозначения насколько важно её решение по отношению к другим ишью и/или к числу игроков, которых она затрагивает.
Обратите внимание, что ишью, которая затрагивает малое число игроков (напр., проблема связанная с аккаунтом одного игрока) будет обозначена как minor, но это не значит, что мы будем игнорировать эту проблему. Мы попытаемся исправить каждую заявленную проблему, если это в наших силах, или если нет простого временного решения. Concerns can be expressed on the issue.
Раздел ишью[]
Для каждой ишью назначается одна или несколько меток section, чтобы сгруппировать ишью по общим разделам на сайте. Например, section: Guilds и section: Market.
section: other - применяется к любым ишью, которые не вписываются ни в один из остальных разделов.
not yet sectioned - применяется к любым ишью, для которых ожидается пока админы назначат им раздел.
Разделы, связанные с испытаниями[]
Для любой ишью связанной с испытаниями назначается метка section: challenges: all. Поскольку существует множество ишью, связанных с испытаниями, они группируются с использованием этих дополнительных меток:
section: challenges: creating / editing - ишью, которые затрагивают создание или редактирование испытаний.
section: challenges: judging - ишью, которые препятствуют создателю испытанию точно определить победителя или закрыть испытание.
section: challenges: other - ишью, затрагивающие испытания, которые не попадают ни под одну из вышеперечисленных двух категорий (обычно, это ишью, когда игрок присоединяется, покидает или использует испытание).
Тип ишью или пул-реквеста[]
Метки type используются только в особых случаях, а новые – появляются редко.
type: bounty - добавляется к любой ишью, которая имеет денежную награду.
good first issue - ишью, которые подходят для новых участников, поскольку их понятно как решить или они считаются простыми. (Ранее эта метка называлась type: entry level coding, но метка good first issue является стандартной на GitHub, поэтому теперь используется она.)
type: medium level coding - ишью, которым требуется больше, чем просто обычное исправление, но возможно оно не такое сложное. Время от времени вы можете обнаружить, что ишью с этой меткой оказались более сложными в разрешении, чем мы думали. Эта метка может не применяться ко всем ишью среднего уровня, поэтому не стоит полагать, что ишью без этой метки не сложные.
type: memorable - особые ишью, которые часто появляются или имеют схожее поведение, которое на самом деле правильное, но некоторые игроки считают, что это ошибка (последние ишью обычно закрываются сразу после создания, но эта метка позволяет их легко найти).
type: translations - ишью, связанные с переводом сайта или мобильных приложений (не переводом вики).
type: notify helpers - применяется ко всем ишью или PR, в которых требуется присутствие Socialites и/или Wiki Wizards, чтобы сообщить когда исправление заработает (напр., значительные исправления багов или существующего поведения; возможно, это не новые функции, т. к. они будут упомянуты в сообщениях Бэйли).
POST-REDESIGN - ишью, которые появились после запуска нового дизайна сайта в конце сентября 2017 года. Исправления для них часто будут приоритетными по сравнению с другими исправлениями.