- read README.md for overview of the project
- use
./check.shto format code, run unit tests - use
./check.sh --test-filter "test name"to run specific tests - use
./check.sh --test-fail-first trueto stop on first test failure - prefer only running specific tests and stopping on the first failure, while working on the feature
- run full check after you are done
Extra notes:
- use
zig envto get the path to the Zig standard library, if you need to check something
Release process:
- Update CHANGELOG.md - change [Unreleased] to [X.Y.Z] with current date
- Update version in build.zig.zon
- Update README.md to reference vX.Y.Z in
zig fetch --savecommand - Commit files with message "Release vX.Y.Z"
- Tag the commit with vX.Y.Z
- Push commit and tags:
git push && git push --tags - Create GitHub release:
gh release create vX.Y.Z --title "vX.Y.Z" --notes "<changelog content>"