Git регламент

Создание репозитория

В первую очередь необходимо на github создать локально репозиторий, название репозитория формируется следующим образом

{**название задания**}-shift-**{год}** // например delivery-shift-20**

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

Работа с веткой

Далее сделайте новую ветку от master/main, название ветки должно отражать суть вашей задачи

git checkout -b {**имя ветки}**

После данной команды вы окажитесь в вашей ветки в которой вы будете работать.

Работа с коммитами

После выполненной работы необходимо закомитить все ваши изменения

git add . // добавить все файлы, если вы хотите добавить конкретные файлы используем "git add {название файла и его расширение}"
git commit -m "Ваше сообщение о внесённых изменениях"
git push --set-upstream origin {**имя ветки}**
git push

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

Мы крайне рекомендуем придерживаться Conventional Commits идеологии:

• feat: Добавление новой функциональности.
• fix: Исправление ошибок.
• docs: Обновление документации.
• style: Изменения, не влияющие на логику (например, форматирование).
• refactor: Рефакторинг кода без изменения функциональности.
• test: Добавление или обновление тестов.
• chore: Обновления, не связанные напрямую с кодом приложения (например, изменения конфигурации).

Создание pull request’а

Чтобы создать pull request, необходимо зайти в ваш репозиторий в github.

После чего зайти в вкладку “Pull request”.

В данной вкладе будут все ваши pull request’ы в которых и будет проходит код ревью.

Чтобы создать новый pull request нужно нажать кнопку “New pull request”

Далее вы увидите селекты с выбором веток, необходимо выбрать ветку в которую вы будете заливать изменения base: master/main и вашу ветку в который вы работали имя ветки

Выбрав необходимую ветку, вы увидите конкретные изменения между master/main и вашей веткой имя ветки, можете нажать “Create pull request” для создания вашего pull request.

При необходимости задайте “title” и “description” для ваших изменений

Поздравляем, вы создали свой pull request, теперь необходимо скинуть ссылку на ваш pull request в чат кураторам на оценку. Вы можете влить/закрыть ваш pull request раньше ревью, чтобы не ждать кураторов и продолжить работу. Кураторы оставят замечания уже на закрытых pull request. Данный замечания вы сможете поправить в следующих pull request’ах отдельными коммитами.

Рекомендации

• Старайтесь делать pull request’а средних или небольших размеров (2-5 коммитов). Кураторам сложнее просматривать большие пул реквесты.
• Не стоит делать пул реквест на пару строчек кода. Можете добавить эти изменения отдельным коммитом в рамках pull request’а с какой-то фичёй