Skip to main content

Contributing to Zoe Relay

Thank you for your interest in contributing to Zoe Relay! This guide will help you get started.

Development Setup​

See the Development Setup guide for instructions on setting up your development environment.

Code Style​

We follow Rust's standard formatting guidelines:

cargo fmt

Testing​

Before submitting a pull request, make sure all tests pass:

cargo test

See the Testing Guide for more details.

Pull Request Process​

  1. Fork the repository
  2. Create a feature branch from main
  3. Make your changes
  4. Add tests for new functionality
  5. Ensure all tests pass
  6. Submit a pull request

Code Review​

All submissions require review. We use GitHub pull requests for this purpose.

Documentation​

When adding new features, please update the relevant documentation:

  • Update API documentation with cargo doc
  • Add or update user-facing documentation in this docs site
  • Include examples where appropriate

Questions?​

If you have questions, please:

  1. Check the existing documentation
  2. Search existing issues on GitHub
  3. Open a new issue if needed