From 699f8733e2a06bf1294b7b3e7af397845ad77a59 Mon Sep 17 00:00:00 2001 From: Sandro Eiler Date: Thu, 28 Dec 2023 22:45:07 +0100 Subject: [PATCH] docs: update README.md on dev dependencies --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) 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