CONTRIBUTING.md

Contributing to TurboPlot

Thank you for your interest in contributing to TurboPlot! This guide provides basic instructions on setting up your development environment and creating a release.

Development Environment

To ensure code quality and consistency, we use pre-commit hooks. You can use pre-commit or it's rust equivalent prek.

1. Installation:

   # Rust
   cargo install --locked prek
   
   # Python
   pip install pre-commit

2. Hooks setup: Run the following command in the repository root:

   # Rust
   prek install
   
   # Python
   pre-commit install
   

   This will install the git hooks that run checks (formatting, clippy, etc.) automatically when you commit changes.

Release Process

To create a new release, follow these steps:

1. Update the Version: Bump the version number in Cargo.toml:

   [package]
   version = "1.2.3" # Update this

2. Commit the Change:

   git add Cargo.toml
   git commit -m "chore: bump version to 1.2.3"
   git push origin master

3. Publish to crates.io: Ensure you are logged in (cargo login) and have the necessary permissions.

   cargo publish

4. Create and Push a Tag: The release workflow is triggered by tags starting with v.

   git tag v1.2.3
   git push origin v1.2.3

5. Automatic Build: The GitHub Actions workflow will automatically:

   • Build turboplot for Linux, Windows, and macOS.
   • Create a GitHub Release for v1.2.3.
   • Upload the built binaries as release assets.