Development

Contributing

Commit Message Header

<type>(<scope>): <short summary>
  │       │             │
  │       │             └─⫸ Summary in present tense. Not capitalized. No period at the end.
  │       │
  │       └─⫸ Commit Scope: file or module
  │
  └─⫸ Commit Type: build|ci|docs|feat|fix|perf|refactor|style|test

Build

Binary

Tmpo is using cross to build cross platform.

cross build --target x86_64-pc-windows-gnu
cross build --release --target x86_64-pc-windows-gnu

Testing

cargo test

Benchmark

Flamegraph

• Follow this steps to install flamegraph
• Run following command

sudo sh -c 'echo 1 >/proc/sys/kernel/perf_event_paranoid'
cargo flamegraph --dev --bin=tmpo init thomas

Codecoverage

• Install grcov
• Run ./scripts/coverage.sh

Override specific dependency

cargo update -p libgit2-sys --precise 0.12.13+1.0.1