CONTRIBUTING.md

Contributing to Floretta

Prerequisites

Be sure to have these tools installed:

• GitHub CLI
• Rust
• uv

Setup

Clone this repository, and open a terminal in that clone:

gh repo clone samestep/floretta
cd floretta

Testing

Use this command to run all the tests:

cargo test

Release

To make a new release, first push a commit updating the version number:

uv run .github/version.py $FLORETTA_VERSION
git commit -m "Release v$FLORETTA_VERSION"
git push

Then create a new GitHub release, choosing the option to Create new tag: v$FLORETTA_VERSION on publish, and using the same v$FLORETTA_VERSION as the release title.