commit-style-guide

KO | EN

gitlite — search

#python #hacktoberfest #react #llm #go #android #machine-learning #deep-learning #docker #java #windows #kubernetes #awesome-list #openai

commit-style-guide

(★ 9)

This repository provides a comprehensive guide on commit naming conventions and best practices for maintaining a clean and organized commit history in KLOKTUN Studio's projects.

commit-style-guide Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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.

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

## Вклад в репозиторий
Если у вас есть вопросы или предложения по улучшению стиля нейминга коммитов, пожалуйста, не стесняйтесь обсудить их с [Данилом](https://github.com/itzme1on) или [Алексеем](https://github.com/kloktunov).

commit-style-guide

commit-style-guide Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

commit-style-guide

commit-style-guide Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README