Одна из основных задач проекта MoonShine — повышение квалификации разработчиков. Работа с GitHub — это основа командной разработки, и правильно и эффективно использовать его должен уметь каждый разработчик. Делать Pull Request в MoonShine — высший пилотаж, а оформлять issues и discussions под силу любому участнику нашего комьюнити.
В этой статье я покажу, как работать с задачами (issues) и обсуждениями (discussions) в репозитории MoonShine на GitHub. Уверен, знание и применение этих навыков сделает разработку MoonShine более эффективной и слаженной.
Когда нужно делать issue?
Если вы обнаружили что-то, что требует изменений в репозитории MoonShine, вы можете (и просто обязаны, если считаете себя true-девелопером) создать задачу (ишью).
Задача (issue) на GitHub - это четко сформулированное предложение по улучшению репозитория. Это может быть исправление ошибок, внедрение новой функциональности, устранение неудобств при разработке и т.д.
Каждая задача должна содержать подробное описание проблем или задач, с которыми вы столкнулись при использовании MoonShine. Кроме этого хорошим тоном при оформлении issue будет указать список возможных причин и описание путей решения.
Написать предложение в чате - это хорошо, но оно может потеряться. Правильно всё фиксировать в репозитории, где ведется и разработка MoonShine и продуктивное обсуждение.
Кроме issue можно создавать discussions. Заметил, что некоторые разработчики путаются между этими разделами. Давайте резберемся.
Отличия issue и discussions
issue (я точно знаю что надо делать!)
- вы уверены что предлагаете нужную фичу
- вы точно нашли баг (и проверили это)
discussions (мне кажется, у меня есть предложение!)
- если вы хотите посоветоваться по какой-то фиче
- у вас есть не оформленное до конца предложение для нового функционала или улучшения уже существующего
- вы нашли проблему, но у вас есть сомнения
Как создать issue
Перейдите на вкладку "Issues" в репозитории и нажмите кнопку "New issue". Эта кнопка находится в строке с поиском и списком меток.
Откроется окно с выбором типа issue, которое я настроил для удобства:
1. "Bug Report" - что-то работает неправильно. Просто заполните все поля. Description (заполняем подробнее что именно не работает) и Steps To Reproduce (оформляем комментарий как воспроизвести эту проблему)
2. Можно сделать issue в свободной форме. После этого откроется страница, где вы можете оформить новую задачу: задать название задачи и описать ее подробно в текстовом поле Description (можно предварительно посмотреть что получается нажавpreview).
После того как вы полностью сформулировали задачу, нажмите кнопку "Submit new issue" для ее сохранения.
3. Feature request - открыть обсуждение которое позволит пользователям и авторам предложить новые идеи или улучшения для MoonShine, получить фидбек. В этом разделе можно сделать анализ оформленных предложений, просмотреть открытые обсуждения и активно взаимодействовать с другими разработчиками MoonShine.
4. "Documentation" - если нашли ошибку в документации MoonShine, или вы настолько хорош, что хотите дополнить документацию, то issue нужно оформить в репозитории doc (документация для MoonShine ведется в отдельном репозитории)
В качестве вывода.
Теперь вы знаете как оформить issue/discussion. Пора закрепить это на практике! Уверен, что у Вас есть что добавить в документацию MoonShine или сделать предложение по какой-то фиче.