39 lines (28 loc) · 1.09 KB

Contributing to Geyser

Thank you for your interest in contributing to Geyser! We welcome contributions from the community.

Getting Started

Fork the repository
Clone your fork: git clone https://github.com/yourusername/geyser.git
Create a new branch: git checkout -b feature/your-feature-name
Make your changes
Run tests: cargo test
Run formatting: cargo fmt
Run clippy: cargo clippy
Commit your changes: git commit -m "Add your feature"
Push to your fork: git push origin feature/your-feature-name
Create a Pull Request

Code Style

Follow Rust standard style guidelines
Run cargo fmt before committing
Ensure cargo clippy passes without warnings
Write clear commit messages

Testing

Add tests for new functionality
Ensure all existing tests pass
Test on multiple platforms when possible

Documentation

Document all public APIs with doc comments
Update README.md if adding new features
Add examples for significant new functionality

Questions?

Feel free to open an issue for questions or discussions about contributions.