|
| 1 | +# Contributing to ZeroEntropy Rust SDK |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the ZeroEntropy Rust SDK! We welcome contributions from the community. |
| 4 | + |
| 5 | +## Getting Started |
| 6 | + |
| 7 | +1. Fork the repository on GitHub |
| 8 | +2. Clone your fork locally |
| 9 | +3. Create a new branch for your feature or bugfix |
| 10 | +4. Make your changes |
| 11 | +5. Run tests to ensure everything works |
| 12 | +6. Submit a pull request |
| 13 | + |
| 14 | +## Development Setup |
| 15 | + |
| 16 | +```bash |
| 17 | +# Clone the repository |
| 18 | +git clone https://github.com/davidatoms/zeroentropy-rust.git |
| 19 | +cd zeroentropy-rust |
| 20 | + |
| 21 | +# Build the project |
| 22 | +cargo build |
| 23 | + |
| 24 | +# Run tests |
| 25 | +cargo test |
| 26 | + |
| 27 | +# Run examples (requires API key) |
| 28 | +export ZEROENTROPY_API_KEY="your-api-key" |
| 29 | +cargo run --example basic |
| 30 | +``` |
| 31 | + |
| 32 | +## Code Style |
| 33 | + |
| 34 | +- Follow standard Rust conventions and idioms |
| 35 | +- Use `cargo fmt` to format your code |
| 36 | +- Run `cargo clippy` to catch common mistakes |
| 37 | +- Write clear, descriptive commit messages |
| 38 | + |
| 39 | +## Testing |
| 40 | + |
| 41 | +- Add tests for new functionality |
| 42 | +- Ensure all existing tests pass |
| 43 | +- Test your changes with real API calls when possible |
| 44 | + |
| 45 | +## Pull Request Process |
| 46 | + |
| 47 | +1. Update the README.md with details of changes if applicable |
| 48 | +2. Update the CHANGELOG.md with your changes |
| 49 | +3. Ensure your code builds and all tests pass |
| 50 | +4. The PR will be reviewed by maintainers |
| 51 | +5. Once approved, your changes will be merged |
| 52 | + |
| 53 | +## Reporting Issues |
| 54 | + |
| 55 | +When reporting issues, please include: |
| 56 | + |
| 57 | +- A clear, descriptive title |
| 58 | +- Steps to reproduce the issue |
| 59 | +- Expected behavior |
| 60 | +- Actual behavior |
| 61 | +- Your environment (OS, Rust version, SDK version) |
| 62 | +- Any relevant error messages or logs |
| 63 | + |
| 64 | +## Code of Conduct |
| 65 | + |
| 66 | +- Be respectful and inclusive |
| 67 | +- Welcome newcomers and help them learn |
| 68 | +- Focus on constructive feedback |
| 69 | +- Maintain professionalism |
| 70 | + |
| 71 | +## Questions? |
| 72 | + |
| 73 | +If you have questions about contributing, feel free to: |
| 74 | + |
| 75 | +- Open an issue for discussion |
| 76 | +- Contact the maintainers at founders@zeroentropy.dev |
| 77 | + |
| 78 | +## License |
| 79 | + |
| 80 | +By contributing, you agree that your contributions will be licensed under the Apache 2.0 License. |
0 commit comments