events4friends

Регламент

Документ содержит информацию о правилах, инструментах и методах совместной работы.

1. Настройка репозитория

Для совместной работы используется веб-сервис для хостинга IT-проектов Github. В зависимости от доступа разработка ведется в основном репозитории или в его форке (копии).

1.1. Работа в одном репозитории

TODO: этот параграф будет заполнен позже

1.2. Работа в форке

Перед началом выполнения любой задачи необходимо убедиться, что форк содержит актуальный код. Для этого необходимо выполнить синхронизацию форка. Инструкция:
https://frontend-basics.blogspot.com/2019/04/syncing-a-fork.html

2. Названия коммитов

Название коммита отображает действие и лаконично отвечает на вопрос «что делает этот коммит?». Соответственно, в названии коммита содержится ответ, который начинается с глагола: «исправляет код стиль», «добавляет функцию getSize» и т.д.

Примеры:
Плохо! "fixed code style", "added Person class", "updated dependencies"
Хорошо! "fix code style", "add Person class", "update dependencies"

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

Примеры:
Плохо! "fix code style", "add Person class"
Хорошо! "#11 fix code style", "#12 add Person class"

3. Одна задача «от» и «до»

Выполнять только одну задачу единовременно в рамках одного проекта:

  1. Перед выполнением задачи необходимо вникнуть в постановку и обсудить все непонятные моменты с создателем задачи.
  2. После выполнения задачи создать pull request. Лично попросить коллег провести код ревью.
  3. После проверки и слияния кода с основной веткой разработки необходимо закрыть задачу и оповестить об этом создателя задачи.

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

4. Общение обязательно

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