11. Pull requests (рекомендации к оформлению)

Для обеспечения высокой читаемости пулл-реквестов (далее - PR) в проектах, необходимо следовать данным правилам оформления. Эти правила помогут упростить процесс code review.

Заголовок PR

Заголовок PR должен включать в себя идентификатор задачи из Jira и краткое описание сути изменений.

Примеры заголовков:

• LABS-1500: change support table styles
• ST-1409: update ui kit to v1.0.8
• BEAT-417: fix enot api

Это обеспечивает немедленное понимание цели PR без необходимости изучения его содержимого.

Описание PR

Описание должно дополнительно разъяснять контекст и детали реализованных изменений. Рекомендуется следующая структура описания:

1. Что делает PR? Описание того, что делает данный PR, желательно от третьего лица, например: "Исправляет размеры иконок в навигационном меню".

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

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

Примеры оформления PR

• Пример 1

• Пример 2

• Пример 3