Правила написания сообщений коммита
Структура:
PREFIX-НОМЕР-НОМЕР краткое описание
Пример:
KS-1-1 add sum calculation
Компоненты:
- Префикс задачи: Тот же, что в ветке (KS-1-1)
- Описание: 2-5 слов о том, что сделано
Правила:
- Маленькие буквы (lowercase)
- Глагол в повелительном наклонении: add, fix, update, remove
- Кратко, без воды
- На английском
- БЕЗ точки в конце
- БЕЗ заглавных букв (кроме префикса)
Примеры хороших сообщений:
KS-1-1 add sum calculation
PROJ-23 fix crash on Android 12
WEB-5 update login button style
API-12 remove deprecated method
Примеры плохих сообщений:
Сделал задачу (русский, непонятно)
fix (нет префикса)
KS-1-1 (нет описания)
Added sum. (заглавная, точка)
Commit vs Commit and Push
Commit (только локально):
- Изменения на вашем компьютере
- НЕ попадают на GitHub
- Нужен отдельный Push
Когда использовать:
- Много мелких коммитов подряд
- Накопить несколько, потом запушить разом
- Работа offline
Commit and Push (локально + GitHub):
- Изменения локально И на GitHub
- Одно действие вместо двух
- Удобнее!
Когда использовать:
- Обычная ситуация для учебных задач
- Сразу видно на GitHub
- Не нужно помнить "запушил или нет?"
Рекомендация: Используйте Commit and Push
Процесс коммита и пуша
Шаг 1: Проверить стейдж
- Убедиться, что отмечены нужные файлы
- При нескольких задачах: только файлы текущей задачи!
Шаг 2: Написать сообщение
- Поле "Commit Message"
- Формат: PREFIX-НОМЕР-НОМЕР описание
Шаг 3: Commit and Push
- Нажать кнопку Commit and Push
Шаг 4: Окно подтверждения
- Проверить: Push 1 Commit to origin/ваша-ветка
- Проверить сообщение коммита
- Нажать Push
Шаг 5: Ожидание
Что происходит при Push
- Git создает коммит локально
- Упаковывает изменения
- Отправляет на GitHub
- GitHub создает удаленную ветку (если нужно)
- Добавляет коммит в ветку
Изменения после коммита
Панель Commit:
- Список Changes пустой
- Все изменения закоммичены
Панель Git → Log:
- Появился новый коммит
- Метки: [ваша-ветка] и [origin/ваша-ветка]
- Обе метки на одном коммите = синхронизировано
Панель Git → Remote Branches:
- Появилась origin/ваша-ветка
- Удаленная версия рабочей ветки
Main не изменился:
- Метки [main] и [origin/main] на Initial Commit
- Правильно! Работали в отдельной ветке
Проверка на GitHub
Желтый баннер:
ваша-ветка had recent pushes
[Compare & pull request]
- GitHub заметил новую ветку
- Предлагает создать Pull Request
- Используем в следующем уроке!
Selector веток:
- Кнопка с названием ветки (слева вверху)
- Список всех веток
- Переключение между ветками
Содержимое ветки:
- Структура файлов
- Новые файлы и папки
- Можно просмотреть код
История коммитов:
- "2 commits" (вверху справа)
- Список всех коммитов ветки
- Клик на коммит → изменения
Синхронизация веток
Локальная ветка: KS-1-1-sum-calculation
- На вашем компьютере
- В панели Git → Local Branches
Удаленная ветка: origin/KS-1-1-sum-calculation
- На GitHub
- В панели Git → Remote Branches
Синхронизация:
- Обе метки на одном коммите в графике
- Локальная = Удаленная
- После Push они всегда синхронны
Важные моменты
⚠️ Проверяйте стейдж:
- При нескольких задачах не коммитьте всё подряд
- Только файлы текущей задачи!
⚠️ Префикс в сообщении:
- Обязательно указывайте префикс задачи
- Легко искать по истории
- Понятно к чему относится коммит
Push сразу после коммита:
- Используйте Commit and Push
- Код сразу в безопасности
- Видно на GitHub