snaeil/zero2prod_axum
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
zero2prod_axum/README.md
Sandro Eiler 8045eb979e feat: red test implementation of email confirm
2024-04-18 14:31:06 +02:00

1.1 KiB
Raw Permalink Blame History

TODO: Add general information about this project

TODO: Explain usage of docker vs podman

TODO: add https://crates.io/crates/cargo-semver-checks

TODO: explain DB migration

To migrate a already deployed and running database, use

SKIP_DB_RUN=true ./scripts/init_db.sh

Contribution

Conventions are enforced through commitizen using pre-commit. Commits that do not comply with the conventions will be rejected.

Prerequisites for developers are:

  • podman
  • postgresql-client
  • sqlx
  • commitizen
  • pre-commit

Current contribution workflow is:

  1. TODO: fork/clone repo and install commitizen and pre-commit
  2. Modify repo
  3. Use cz c to add a commit
  4. Push changes
  5. Open pull/merge request

Maintainance

Versioning:

TODO; explain versioning

Check for unused dependencies:

Requirement: Needs cargo install cargo-udeps --locked

cargo +nightly udeps --all-targets

Test with more output:

cargo test -- --nocapture

Test with tracing output:

Requirement: Needs cargo install bunyan

TEST_LOG=true cargo test | bunyan