Skip to content

Commit

Permalink
docs: updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
dmytro-komlyk committed Jun 10, 2024
1 parent 748e143 commit bf2edcb
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit bf2edcb

Please sign in to comment.