docs: update README.md on dev dependencies
This commit is contained in:
parent
5737087436
commit
699f8733e2
1 changed files with 12 additions and 2 deletions
14
README.md
14
README.md
|
|
@ -1,8 +1,8 @@
|
||||||
TODO:
|
TODO: Add general information about this project
|
||||||
|
|
||||||
## Contribution
|
## 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.
|
Commits that do not comply with the conventions will be rejected.
|
||||||
|
|
||||||
Prerequisites for developers are:
|
Prerequisites for developers are:
|
||||||
|
|
@ -10,3 +10,13 @@ Prerequisites for developers are:
|
||||||
- podman
|
- podman
|
||||||
- postgresql-client
|
- postgresql-client
|
||||||
- sqlx
|
- 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
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue