Правила работы с git

[temikfart]

В топике #5 были предложены правила работы с git, которые будут использовать в этом проекте.

Commit'ы

<Краткое описание (не более 50 символов)>
<Пустая строка>
<Подробное описание (не более 72 символов в ширину)>

Краткое описание будет иметь вид: [#123] Add unit tests. То есть:

• сначала в квадратных скобках пишется номер issue, к которому относятся изменения;
• затем, с большой буквы следует краткое описание коммита;
• описание коммита обычно начинается с глагола в инфинитиве (комит описывает "какие изменения он делает", а не "что было сделано");
• Точку в конце короткого описания ставить не нужно.

Остальное:

• Пустая строка отделяет длинное описание коммита от короткого;
• Длинное описание опционально, если в коротком описании непонятно, что было сделано;
• Длина в 50 символов общепризнана.

Branch'и

feature/123-test-io-module
Здесь:

• сначала пишется токен token/, который группирует ветки. Это могут быть:
  • feature
  • fix
  • ...
• далее пишется номер issue;
• аналогично короткому описанию коммита, пишется краткое описание того, что добавляет эта ветка, в примере написано test-io-module, т.е. добавится тестирование input/output модуля.

merge vs. rebase

Мы используем git rebase. Никаких merge и squash'ей!.

Pull Request

В описании расскажите, какие изменения предлагает ваш ПР:

• Идея алгоритма
• Обновления в документации
• Описание фичи
• и т.д.

Когда вы делаете Pull Request вы обязаны дождаться review товарища, чтобы он проверил ваши изменения и одобрил. Только после этого вы сможете влить изменения в main ветку.

Обязательно заполните поля:

• Reviewers (если знаете, кто будет проверять ваш ПР)
• Assignees (себя и того, кто по вашему мнению причастен)
• Labels (если нужно, создавайте новые, но старайтесь переиспользовать старые)
• Projects: coolstory-gram project
  • Status: Backlog
  • Priority
  • Size

Issue

При оформлении нового issue, вы должны описать проблему и, если есть, предполагаемое решение. Обязательно заполните поля:

• Assignees (себя и того, кто по вашему мнению причастен)
• Labels (если нужно, создавайте новые, но старайтесь переиспользовать старые)
• Projects: coolstory-gram project
  • Status: Backlog
  • Priority
  • Size