Как создавать задачи GitHub в 5 раз быстрее

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

Одна из проблем, с которыми я сталкиваюсь при работе с проблемами GitHub, заключается в том, что их сложно создавать, особенно для тех, кто не является разработчиком или дизайнером, например для менеджеров или тестировщиков, которые хотят сообщить об ошибке, не проходя процесс ее создания. на Гитхабе.

Некоторое время назад я писал о приложении, которое я писал для ускорения создания задач GitHub. На самом деле я создаю приложение, но потом забыл написать об этом здесь, так что вот правильный пост в блоге. В этом посте мы увидим:

2. Написание пакета задач GitHub с помощью обычного текста
3. Технический стек приложения
4. Больше идей по улучшению создания задач

Почему приложение для создания задач GitHub быстрее?

Пользовательский интерфейс GitHub обычно подходит для создания задачи. Или два. И это нормально для технически подкованных людей, таких как разработчики или дизайнеры. Однако в нашей компании Reconnect иногда после разработки новой функции мы просим наш нетехнический персонал протестировать ее. И это прекрасно работает, потому что обычно они находят какие-то проблемы. Но для них очень утомительно идти и прыгать через пользовательский интерфейс проблем GitHub. Это еще более обременительно, когда им нужно создать более одной задачи и, возможно, в разных репозиториях.

Если мы подсчитаем, сколько раз мы переключаем наше внимание на создание задач GitHub после того, как мы достигли страницы для создания задачи в репозитории, где мы хотим их создать, это будет примерно так:

• введите название
• перейдите в текстовое поле задачи, чтобы ввести описание
• перейдите на боковую панель, чтобы назначить проблему кому-то
• перейдите к блоку «Ярлыки» на боковой панели, чтобы добавить ярлык
• иди и нажми кнопку, чтобы создать проблему

Это 5 раз, когда мы переключаем наше внимание с области на область! Слишком много внимания переключается на задачу, которая по сути состоит в написании, и слишком много времени тратится на перефокусировку. А что, если вам нужно написать задачу в другой репозиторий? Вы должны перейти к этому репозиторию в новой вкладке или в текущей, и это потеряет больше времени.

Так как же проще и быстрее создавать задачи GitHub? Не было бы проще, если бы мы могли сфокусироваться на одном месте, не переключая наше внимание несколько раз?

Написание пакета задач GitHub с помощью обычного текста

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

Это приложение делает именно это: https://fast-issues.herokuapp.com/

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

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

• название на первом месте
• затем символы вертикальной черты отделяют правопреемников. Я решил, что это так, потому что как минимум вам нужна проблема и кто-то, кто над ней поработает.
• вторая вертикальная черта отделяет описание проблемы. Он может иметь любую длину, но не может иметь разрывов строк, потому что это приведет к возникновению новой проблемы.
• третий символ вертикальной черты разделяет метки

Он поддерживает несколько правопреемников и меток, разделяя их запятой. Итак, в основном:

This is the title | username1, username2 | This is the issue description, as long as you want it but without line breaks. | Label 1, Label 2<br>This is another issue | username3 | And another issue description | Bug

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

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

Технический стек приложения

Репозиторий этого приложения находится по адресу https://github.com/eliorivero/fast-issues .

Технический стек особенно прост и полностью основан на JavaScript :

• интерфейс, созданный с помощью React
• бэкэнд, созданный с помощью Node.js
• использует Express в качестве сервера
• и Octokit REST — библиотека для работы с GitHub API.

Следует иметь в виду, что мы не хотим превышать лимит запросов, разрешенный GitHub Issues API. Они рекомендуют, чтобы между запросами проходило не менее одной секунды, поэтому я приостанавливал выполнение на 1,5 секунды между созданием каждой задачи.

От первоначального прототипа, который я сделал, до финальной версии, я изменил его с приложения GitHub на приложение OAuth. Это потому, что последний позволяет вам создавать проблемы и выступать в качестве автора.

Больше идей по улучшению создания задач

Я показал это другу, и он сказал мне, что у него была идея создать расширение для Chrome, чтобы сделать снимок экрана с ошибкой, аннотировать его и отправить как проблему на GitHub. Я подумал, что это отличная идея, поэтому я искал способ сделать снимок экрана, но внутри приложения React, и быстро нашел html2canvas, который позволяет делать снимки экрана и сохранять их в виде файлов PNG.

Сочетание чего-то подобного с моим инструментом для создания задач было бы хорошим решением, которое могло бы быть доступно в приложении React во время его цикла разработки или подготовки. Любой, кто тестирует приложение, может запустить панель отчетов о проблемах и отправить сообщение о проблеме на GitHub.

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

Итак, еще раз, приложение находится по адресу https://fast-issues.herokuapp.com/, и если вы в конечном итоге используете его, сообщите мне об этом в комментариях.