Создание шаблонов запросов на Github

Начало работы

Чтобы создать шаблон для вашего репозитория, все, что вам нужно сделать, это создать файл с именем PULL_REQUEST_TEMPLATE.md либо в:

  • папке .github — мой предпочтительный вариант здесь
  • корень вашего проекта
  • папке docs

Когда этот файл будет помещён в ветку по умолчанию для проекта, Github начнёт использовать его в качестве шаблона по умолчанию для новых запросов на исправление. Это так просто! ✨

Преимущества

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

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

Прошли те времена, когда, открыв запрос на исправление, вы видели ужасные слова «Нет описания» — это никому не нужно. Теперь вы и ваши соавторы сможете открыть PR и быстро понять, что это за изменение и почему оно было создано.

Мои шаблоны

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

Проект совместной работы внутренней команды

## Description 📋

Please include a summary of the changes made in this PR.

## Type of change 🤔

Please tick any that are relevant to this PR and remove any that aren't.

- [ ] Bugfix 🐛
- [ ] Feature 🥳
- [ ] Refactoring 🤓
- [ ] CI 🤖
- [ ] Documentation 📒
- [ ] Tests 🧪
- [ ] Other (please detail in description) ❓

## Screenshots 📷

If possible provide screenshots of your visual changes to make it easier for reviewers.
Вход в полноэкранный режим Выход из полноэкранного режима

Проект с открытым исходным кодом

## Description 📋

Please include a summary of the changes made in this PR and provide any context necessary for the change.
Fixes # (issues)

## Type of change 🤔

Please tick any that are relevant to this PR and remove any that aren't.

- [ ] Bugfix (non breaking change which resolve an issue)
- [ ] Feature (non breaking change which adds functionality)
- [ ] Breaking Change (a change which would cause existing functionality to not work as expected)
- [ ] Documentation (a change to documentation)

## Submission checklist ✅

- [ ] I have performed a self review of my changes
- [ ] I have updated the documentation where relevant
- [ ] My changes are well written and all ci is passing
Вход в полноэкранный режим Выход из полноэкранного режима

Минимальный

## Description 📋

Please include a summary of the changes made in this PR and provide any context necessary for the change.

Войти в полноэкранный режим Выход из полноэкранного режима

Оставьте комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *