diff --git a/CONTRIBUTING.ru.md b/CONTRIBUTING.ru.md new file mode 100644 index 0000000..d1b7e2a --- /dev/null +++ b/CONTRIBUTING.ru.md @@ -0,0 +1,41 @@ +При создании коммитов необходимо придерживаться стандарта Conventional Commits + +Основной формат: + +`: ` + +При необходимости можно дополнительно указывать область изменения: + +`(): ` + +`scope` не является обязательным, поэтому оба варианта являются корректными + +Например: + +`feat: add user authentication` + +`feat(auth): add user authentication` + +`fix: handle invalid input` + +`fix(validation): handle invalid input` + +`build: update Maven compiler release to Java 21` + +`build(maven): update Maven compiler release to Java 21` + +Основные типы, которые будем использовать: + +- `feat` — добавление новой функциональности +- `fix` — исправление ошибки +- `build` — изменения, связанные со сборкой и зависимостями +- `refactor` — изменение кода без изменения поведения +- `test` — добавление или изменение тестов +- `docs` — изменения документации +- `chore` — прочие технические изменения + +`scope` рекомендуется указывать, когда он помогает понять, какой части проекта касается изменение, например `auth`, `api`, `database`, `maven` + +Описание коммита должно быть кратким и отражать суть изменения + +Перед созданием коммита необходимо убедиться, что он соответствует формату Conventional Commits