From bf2edcbbe926686fd43c34984a62ce9eb7bb7e8b Mon Sep 17 00:00:00 2001 From: Dmitriy Date: Mon, 10 Jun 2024 10:29:14 +0300 Subject: [PATCH] docs: updated README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 4853196..cb5305b 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,22 @@ To run the project using Docker, use the provided docker-compose files. docker compose -f docker-compose.local.yml up -d ``` +## Git Hooks with Husky and Commitlint + +This project uses Husky to manage Git hooks and Commitlint to enforce conventional commit messages. + +### Example Commit Message Guidelines + +- feat: A new feature +- fix: A bug fix +- docs: Documentation only changes +- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) +- refactor: A code change that neither fixes a bug nor adds a feature +- perf: A code change that improves performance +- test: Adding missing tests or correcting existing tests +- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) +- ci: Changes to CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) + ## Deploy ### CI/CD Pipeline