How to Contribute - louisphilipmarcoux/rill-json GitHub Wiki

We welcome contributions of all kinds, from bug reports to new features!

Code of Conduct

This project adheres to the Rust Code of Conduct. We are committed to providing a friendly, safe, and welcoming environment for all.

Reporting Bugs

If you find a bug, please open an issue and provide:

  • A clear description of the bug.
  • The smallest possible JSON input that reproduces it.
  • The error message you received (if any).
  • The expected behavior.

Submitting Pull Requests

If you'd like to contribute code, please follow these steps:

  1. Fork the repository.
  2. Clone your fork locally: git clone https://github.com/YOUR_USERNAME/rill-json.git
  3. Create a new branch for your feature: git checkout -b my-new-feature
  4. Make your changes.
  5. Run the full check suite before committing[cite: 79]. This is what the CI pipeline runs:
    • Format: cargo fmt --all [cite: 79]
    • Lint: cargo clippy --all-targets -- -D warnings (This treats warnings as errors)
    • Test: cargo test
  6. Commit your changes: git commit -am 'feat: Add my new feature'
  7. Push to your branch: git push origin my-new-feature
  8. Open a Pull Request on the main louisphilipmarcoux/rill-json repository.