diff --git a/README.md b/README.md index 5c3ffc0..11885f8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -TODO: +TODO: Add general information about this project ## Contribution -Conventions are enforced through pre-commit. +Conventions are enforced through commitizen using pre-commit. Commits that do not comply with the conventions will be rejected. Prerequisites for developers are: @@ -10,3 +10,13 @@ Prerequisites for developers are: - podman - postgresql-client - sqlx +- commitizen +- pre-commit + +Current contribution workflow is: + +0. TODO: fork/clone repo and install commitizen and pre-commit +1. Modify repo +2. Use `cz c` to add a commit +3. Push changes +4. Open pull/merge request