KLOKTUN

Добро пожаловать в этот репозиторий!

Нейминг коммитов

Мы используем следующий стиль нейминга коммитов, чтобы улучшить понимание изменений, внесенных в репозиторий / проект. Каждый коммит начинается с приписки, которая указывает на тип изменения, затем идёт двоеточие и краткое разъяснение внесённых изменений. Вы также можете указать в круглых скобках конкретную часть проекта, в которую вы внесли изменения, если их несколько, но это не является обязательным.

Ниже приведёны префиксы, которые мы используем, и разъяснение их значений:

Список префиксов

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

fix: Используется для коммитов, связанных с исправлением ошибок или проблем в проекте.

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

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

docs: Используется для коммитов, связанных с изменениями в документации проекта, например, обновление README-файла, добавление документации к коду, комментариев и т.д.

style: Используется для коммитов, связанных с изменением внешнего вида кода без влияния на его работу, например, форматирование кода с помощью Prettier, исправление опечаток и т.д.

move: Используется для коммитов, связанных с перемещением файлов в другую папку, например, для объединения блоков страницы, если они разбиты на отдельных файлы.

delete: Используется для коммитов, связанных с удалением неиспользуемых файлов.

test: Используется для коммитов, связанных с добавлением, изменением или исправлением тестов в проекте.

Примеры

feat(Ecosystem): new ecosystem sections ― В этом примере мы видим, что была добавлена новая функциональность в раздел Ecosystem. Конкретно, были внесены изменения, связанные с созданием новых секций в разделе Ecosystem.

chore: replace jpg with webp format ― В этом примере мы видим, что старый формат jpg был заменён новым webp. Каких-то значительных изменений внесено не было.

docs(README): update installation instructions ― В этом примере мы видим, что были внесены изменения в документацию проекта, в частности, были обновлены инструкции по установке в файле README.

Послесловие

Я призываю всех разработчиков следовать стилю, описанному выше, потому что он очень удобен и понятен. Это поможет нам поддерживать чистую и структурированную историю коммитов и улучшит понимание внесенных изменений.

Вклад в репозиторий

Если у вас есть вопросы или предложения по улучшению стиля нейминга коммитов, пожалуйста, не стесняйтесь обсудить их с Данилом или Алексеем.