Commit Template

Це шаблон документації комміту. Просто замініть текст-заповнювач на свій власний.

Додайте тут назву вашого комміту

Це початкова точка поточного сховища для повідомлень git commit. Не соромтеся редагувати цей шаблон відповідно до ваших потреб. Для отримання додаткової інформації про повідомлення git commit відвідайте: Git Commit Message Guidelines.

Відповідні посилання

Посилання на відповідні веб-сторінки, трекери випусків, статті в блогах тощо. Приклади:

Див: https://example.com
Див: Приклад сторінки

Співавтори

Перелічіть усіх співавторів, щоб забезпечити належне посилання. Приклади:

Співавтори: Ім’я name@example.com
Співавтори: Ім’я name@example.com

Чому

Опишіть причину цієї зміни. Які цілі, варіанти використання або історії стоять за цим?

Як

Поясніть деталі реалізації. Які алгоритми, методи або кроки були використані?

Довідка

Поради щодо заголовка

Використовуйте дієслова в наказовому способі з великої літери:

Додати: Створити можливість (наприклад, функцію, тест, залежність).
Drop: Видалити можливість (наприклад, функцію, тест, залежність).
Виправити**: Виправити проблему (наприклад, помилку, друкарську помилку, нещасний випадок, неправильне твердження).
Bump: Збільшити версію чогось (наприклад, залежності).
Зробити**: Змінити процес збірки, інструменти або інфраструктуру.
Почати**: Почати щось робити (наприклад, увімкнути перемикач, прапорець функції тощо).
Stop: Завершити виконання чогось (наприклад, вимкнути перемикач, прапорець функції тощо).
Оптимізувати: Зміна, яка покращує продуктивність (наприклад, пришвидшує роботу коду).
Документувати: Зміна, яка впливає лише на документацію (наприклад, файли довідки).
Рефактор: Зміна, яка є суто рефакторингом.
Переформатувати: Зміна, яка є суто форматуванням (наприклад, відступи рядків, обрізання пробілів).
Перефразувати**: Зміни, які є суто текстовими (наприклад, редагування коментаря, документа тощо).

Правила написання теми

Використовуйте максимум 50 символів.
Не ставте крапку.

Правила основного тексту

Використовуйте стільки рядків, скільки необхідно.
Обертайте рядки максимум 72 символами.

Використання

Щоб використовувати цей шаблон, розмістіть файл тут:

~/.git_commit_template.txt

Налаштуйте git на використання шаблону:

git config --global commit.template ~/.git_commit_template.txt

Додайте наступне до вашого файлу ~/.gitconfig:

[commit]
  template = ~/.git_commit_template.txt

Налаштуйте розташування та використання файлу за потребою.

Відстеження

Package: GITCOMMIT.md
Version: 1.0.0
Updated: 2024-07-20T22:15:57Z
License: MIT
Contact: Nazar Kornienko (blefnk@gmail.com)