Проблемы с освоением

Проблемы — отличный способ отслеживать задач, улучшений и ошибок для ваших проектов. Они похожи на электронную почту, за исключением того, что ими можно поделиться и обсудить с остальной частью вашей команды. В большинстве программных проектов есть какое-то средство отслеживания ошибок. Трекер GitHub называется Issues и имеет свой собственный раздел в каждом репозитории.

Например, давайте взглянем на раздел проблем Bootstrap:

Отслеживание проблем GitHub является особенным, потому что мы сосредоточены на совместной работе, ссылках и отличном форматировании текста. Типичная проблема на GitHub выглядит примерно так:

  • title и description описывают суть проблемы.

  • Цветные ярлыки помогают классифицировать и фильтровать ваши проблемы (как и ярлыки в электронной почте).

  • веха действует как контейнер для проблем. Это полезно для связывания проблем с конкретными функциями или этапами проекта (например, Weekly Sprint 9/5-9/16 или Shipping 1.0 ).

  • Один исполнитель отвечает за работу над проблемой в любой момент времени.

  • Комментарии позволяют любому, у кого есть доступ к репозиторию, оставлять отзывы.

Вехи, ярлыки и исполнители

После того, как вы собрали много проблем, вам может быть трудно найти те, которые вам небезразличны. Контрольные точки , ярлыки и исполнители — отличные возможности для фильтрации и классификации проблем.

Вы можете изменить или добавить веху, исполнителя и метки, щелкнув соответствующие шестеренки на боковой панели справа.

Если вы не видите кнопок редактирования, это потому, что у вас нет разрешения на редактирование проблемы. Вы можете попросить владельца репозитория добавить вас в качестве соавтора для получения доступа.

Вехи

Вехи — это группы проблем, которые соответствуют проекту, функции или периоду времени. Люди используют их по-разному при разработке программного обеспечения. Некоторые примеры вех на GitHub включают:

  • Запуск бета-версии — файлы ошибок, которые необходимо исправить перед запуском. бета-версия вашего проекта. Это отличный способ убедиться, что вы ничего не упускаете.

  • October Sprint — Проблемы с файлами, которые вы могли бы люблю поработать в октябре. Отличный способ сосредоточить усилия, когда есть много дел.

  • Редизайн — проблемы с файлами, связанные с изменением дизайна вашего проекта. Отличный способ собрать идеи о том, над чем работать.

Ярлыки

Ярлыки — отличный способ систематизировать различные типы задач . У проблем может быть столько ярлыков, сколько вам нужно, и вы можете фильтровать по одному или нескольким ярлыкам одновременно.

Правопреемники

У каждой задачи может быть уполномоченный — одно лицо, ответственное за продвижение проблемы. Назначенные лица выбираются так же, как и контрольные точки, через серую полосу вверху задачи.

Уведомления, @ упоминания и ссылки

Используя @ упоминания и ссылки внутри Issues, вы можете уведомлять других пользователей и команды GitHub, а также перекрестно соединять проблемы друг с другом. Они обеспечивают гибкий способ привлечь нужных людей для эффективного решения проблем, их легко изучить и использовать. Они работают со всеми текстовыми полями на GitHub — они являются частью нашего синтаксиса форматирования текста, который называется GitHub Flavored Markdown.

Если вы хотите узнать больше, ознакомьтесь с Mastering Markdown .

Уведомления

Уведомления — это способ GitHub быть в курсе ваших проблем. Вы можете использовать их, чтобы узнавать о новых проблемах в репозиториях или просто знать, когда кому-то понадобится ваш вклад для продвижения по проблеме.

Есть два способа получать уведомления: по электронной почте и через Интернет. Вы можете настроить способ получения уведомлений в настройках. Если вы планируете получать много уведомлений, мы рекомендуем вам получать веб-уведомления по электронной почте для Участие и веб-уведомления для Watching .

С этими настройками вы будете получать электронные письма, когда люди конкретно упоминают вас, а затем посетите веб-интерфейс, чтобы быть в курсе интересующих вас репозиториев.

Вы можете получить доступ к своим уведомлениям через экран уведомлений. На этом экране удобно сканировать сразу несколько уведомлений и отмечать их как прочитанные или отключать поток. Попробуйте использовать здесь сочетания клавиш, чтобы ускорить рабочий процесс — нажмите ? на странице, чтобы узнать, какие сочетания клавиш доступны.

Заблокированные цепочки больше не будут отображаться как непрочитанные до тех пор, пока вы снова не будете специально @ упомянуты. Это делает отключение звука отличной стратегией для потоков, которые вас мало интересуют (возможно, подсистемы, с которой вы не знакомы). Если вы отметите проблему как прочитанную, она останется такой, пока кто-нибудь снова не прокомментирует ветку..

GitHub также синхронизирует статус прочитанного/непрочитанного для уведомлений по электронной почте — если вы прочитаете уведомление в своем почтовом клиенте, оно будет помечено как прочитанное в веб-интерфейсе (убедитесь, что вы разрешили свой почтовый клиент для отображения изображений, если вам нужна эта функция).

@mentions

@mentions — это способ, которым мы ссылаемся на других пользователей GitHub внутри GitHub Issues. Внутри описания или любого комментария проблемы укажите @username другого пользователя GitHub, чтобы отправить ему уведомление. Это работает очень похоже на то, как Twitter использует @mentions.

Нам нравится использовать синтаксис /cc (аббревиатура для точной копии), чтобы включать людей в проблемы:

Похоже, новая форма виджета в Safari не работает. Когда я пытаюсь создать виджет, Safari вылетает. Это воспроизводимо на 10.8, но не на 10.9. Может быть, ошибка браузера?

/cc @kneath @jresig

Это отлично работает, если вы знаете конкретных пользователей, которых нужно включить, но часто мы мы работаем в разных командах и на самом деле не знаем, кто может нам помочь. @mentions также работают для команд в вашей организации GitHub. Если вы создаете команду под названием browser-bugs в организации @acmeinc, вы можете ссылаться на команду с помощью @mentions:

/cc @ acmeinc/browser-bugs

Это отправит уведомления каждому члену команды разработчиков ошибок браузера.

Ссылки

Часто проблемы зависят от других проблем или, по крайней мере, относятся к ним, и вы хотели бы соединить эти два вопроса. Вы можете ссылаться на проблемы, введя хэштег и номер проблемы.

Привет, @kneath, я думаю, проблема началась в # 42

Когда вы это сделаете, мы создадим событие внутри проблемы № 42, которое будет выглядеть примерно так:

Проблема в другом репозитории? Просто включите репозиторий перед именем, например Kneath/example-project # 42 .

Один из наиболее интересных способов использования проблем GitHub — это ссылка на проблемы непосредственно из совершает. Включите номер проблемы в сообщение о фиксации.

Автор Если перед вашими коммитами указать «Fixes», «Fixed», «Fix», «Closes», «Closed» или «Close», когда коммит объединяется с основным, это также автоматически закроет проблему.

Ссылки позволяют глубоко связать выполняемую работу с отслеживаемой ошибкой и являются отличным способом добавить видимости в историю вашего проекта.

Поиск

В самом верху каждой страницы находится поле поиска, которое позволяет искать проблемы.

Результаты поиска можно ограничить по:

  • Ключевому слову, например, всем проблемам, связанным с боковой панелью

  • Укажите, например, все проблемы, упоминающие боковую панель, которые закрыты

  • Исполнитель, например as, все проблемы с упоминанием боковой панели, которые были назначены для @mdo

Наша справочная статья по вопросам поиска может показать вам другие способы поиска: с использованием дат создания/обновления, ярлыки, авторы, количество комментариев, по владельцу репозитория и т. д.

Обзоры и отчеты

Вне раздела «Проблемы», есть две другие страницы, которые помогают обобщить, что происходит с проблемами в вашем репозитории и во всех ваших репозиториях.

Панель управления проблемами

Если вы ищете Благодаря более широкому списку всех ваших проблем во многих проектах, панель задач может стать отличным инструментом. Панель управления работает очень похоже на раздел проблем, но собирает проблемы по-другому:

  • Все проблемы в репозиториях владеете ли вы и совместно работаете над решением
  • Задач, назначенных вам
  • Созданных вами вопросов

Если вы пользуетесь услугами организаций , у каждого из них есть своя панель управления проблемами, которая разделяет проблемы внутри организации.

Pulse

Под каждым репозиторием находится раздел под названием Pulse — Pulse — это снимок всего, что произошло в репозитории за последнюю неделю (или день, или последние 3 месяца и т. д.).

Это отличный способ наверстать упущенное с репозиториями, когда вы отсутствуете и не хотите получать уведомления о детализации при просмотре репозитория.

Другое использование для проблем

Проблемы отлично подходят для отслеживания всех видов вещей, а GitHub — отличное место для простого обмена и совместной работы по вашим вопросам. Вот некоторые из наших любимых:

  • Отслеживание ошибок для ваших проектов с открытым исходным кодом

  • Запрос рецепта (может быть, у вас есть хороший рецепт теста для пиццы без глютена? )

Fin

А теперь поздравьте себя — это было много читать! Управление проблемами — один из самых мощных инструментов, имеющихся в распоряжении любого разработчика. Думаю, все, что осталось, это исправить ошибки прямо сейчас.



О проблемах

Используйте проблемы для отслеживания идей, улучшений, задач или ошибок при работе на GitHub.

О проблемах

Вы можете собирать отзывы пользователей, сообщать об ошибках программного обеспечения и организовывать задачи, которые вы хотели бы решить с проблемами в репозитории. Проблемы могут быть чем-то большим, чем просто местом для сообщения об ошибках в программном обеспечении.

Другие разговоры более подходят для обсуждения. Вы можете использовать обсуждения, чтобы задавать вопросы и отвечать на них, делиться информацией, делать объявления, а также вести или участвовать в обсуждениях проекта. Для получения дополнительной информации см. «Об обсуждениях».

Вы не можете преобразовать обсуждение в проблему.

Вы можете связать запрос на вытягивание с проблемой, чтобы показать, что исправление выполняется и автоматически закрывает проблему, когда кто-то объединяет запрос на перенос. Для получения дополнительной информации см. «Связывание запроса на вытягивание с проблемой».

Чтобы оставаться в курсе самых последних комментариев к проблеме, вы можете следить за проблемой и получать уведомления о последних комментариях. Для получения дополнительной информации см. «Об уведомлениях».

Чтобы быстро найти ссылки на недавно обновленные выпуски, на которые вы подписаны, посетите свою панель управления. Для получения дополнительной информации см. «О вашей личной панели управления».

Работа с проблемами

С проблемами вы можете:

  • Отслеживайте и расставляйте приоритеты для своей работы с помощью досок проектов. Дополнительные сведения см. В разделе «Использование досок проектов».
  • Создавайте новые задачи, чтобы отслеживать выходящие за рамки отклики на комментарий в проблеме или проверку запроса на вытягивание. Для получения дополнительной информации см. «Открытие проблемы из комментария».
  • Создавайте шаблоны задач, чтобы помочь участникам открывать значимые проблемы. Дополнительные сведения см. В разделе «О шаблонах задач и запросов на вытягивание».
  • Переносите открытые проблемы в другие репозитории. Для получения дополнительной информации см. «Перенос проблемы в другой репозиторий».
  • Закрепите важные проблемы, чтобы их было легче найти, предотвращая дублирование проблем и уменьшая шум. Для получения дополнительной информации см. «Закрепление проблемы в репозитории».
  • Отслеживайте повторяющиеся проблемы с помощью сохраненных ответов. Дополнительные сведения см. В разделе «О сохраненных ответах».
  • Сообщайте о комментариях, нарушающих принципы сообщества GitHub. Дополнительную информацию см. В разделе «Сообщение о злоупотреблениях или спаме».

Проблемы также могут быть назначены другим пользователям, помечены ярлыками для более быстрого поиска и сгруппированы по этапам.

Помогите нам сделать эти документы отличными!

Все документы GitHub имеют открытый исходный код. Видите что-то неправильное или непонятное? Отправьте запрос на перенос.

Сделайте взнос

Или узнайте, как внести свой вклад.

Оцените статью
clickpad.ru
Добавить комментарий