Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (58 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

86 lines (58 loc) · 2.5 KB

Contributing to toon-rust

Thank you for your interest in contributing to the official Rust implementation of TOON!

Project Setup

This project uses Cargo for dependency management.

# Clone the repository
git clone https://github.com/toon-format/toon-rust.git
cd toon-rust

# Build the project
cargo build

# Initialize and clone the spec submodule (required for tests)
git submodule update --init --recursive

# Run tests
cargo test

Development Workflow

  1. Fork the repository and create a feature branch
  2. Make your changes following the coding standards below
  3. Add tests for any new functionality
  4. Ensure all tests pass and coverage remains high
  5. Submit a pull request with a clear description

Coding Standards

Code Style

  • Follow Rust standard formatting conventions
  • Run cargo fmt before committing
  • Run cargo clippy to catch common mistakes

Testing

  • All new features must include tests
  • Maintain test coverage at 85%+ line coverage
  • Tests should cover edge cases and spec compliance
  • Run the full test suite: 
    cargo test

SPEC Compliance

All implementations must comply with the TOON specification.

Before submitting changes that affect encoding/decoding behavior:

  1. Verify against the official SPEC.md
  2. Add tests for the specific spec sections you're implementing
  3. Document any spec version requirements

Pull Request Guidelines

  • Title: Use a clear, descriptive title
  • Description: Explain what changes you made and why
  • Tests: Include tests for your changes
  • Documentation: Update README or documentation if needed
  • Commits: Use clear commit messages (Conventional Commits preferred)

Your pull request will use our standard template which guides you through the required information.

Communication

  • GitHub Issues: For bug reports and feature requests
  • GitHub Discussions: For questions and general discussion
  • Pull Requests: For code reviews and implementation discussion

Maintainers

This is a collaborative project. Current maintainers:

All maintainers have equal and consensual decision-making power. For major architectural decisions, please open a discussion issue first.

License

By contributing, you agree that your contributions will be licensed under the MIT License.