Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (42 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

61 lines (42 loc) · 1.38 KB

Contributing to Taskmill

Thanks for your interest in contributing! This document covers the basics to get you started.

Getting Started

Prerequisites

Setup

git clone https://github.com/deepjoy/taskmill.git
cd taskmill
lefthook install
cargo build

Running Tests

cargo test --all-features

Formatting and Linting

The project uses cargo fmt and clippy. Lefthook runs these automatically on pre-commit, but you can run them manually:

cargo fmt --check
cargo clippy --all-features -- -D warnings

Making Changes

  1. Fork the repository and create a branch from main.
  2. Make your changes.
  3. Add tests for new functionality.
  4. Ensure cargo test --all-features passes.
  5. Ensure cargo clippy --all-features -- -D warnings is clean.
  6. Open a pull request against main.

Commit Messages

This project uses Conventional Commits:

feat: add new feature
fix: correct a bug
docs: update documentation
refactor: restructure code without behavior change
chore: maintenance tasks

These are used by release-plz to auto-generate changelogs and determine version bumps.

Questions?

Open an issue or start a discussion — happy to help.