# Contributing to rs-query
First off, thank you for considering contributing to rs-query! This project is in its early stages and we genuinely need help from the community to make it better.
## The State of This Project
Let's be real: this library was built by someone learning Rust, with AI assistance. The code works, but it likely doesn't follow all Rust idioms and best practices. If you're an experienced Rustacean, your expertise is especially valuable here.
We're looking for help with:
- **Code review** — Point out anti-patterns, unsafe code, or inefficiencies
- **Testing** — We need comprehensive unit tests, integration tests, and property-based tests
- **Documentation** — Improve rustdoc comments and examples
- **API design** — Suggest improvements to make the API more ergonomic
- **Performance** — Identify bottlenecks and optimize hot paths
## Getting Started
1. Fork the repository
2. Clone your fork:
```bash
git clone https://github.com/YOUR_USERNAME/rs-query.git
cd rs-query
```
3. Create a branch:
```bash
git checkout -b my-feature
```
4. Make your changes
5. Run tests:
```bash
cargo test
cargo clippy
cargo fmt --check
```
6. Commit and push:
```bash
git commit -m "feat: add awesome feature"
git push origin my-feature
```
7. Open a Pull Request
## Code Style
- Run `cargo fmt` before committing
- Run `cargo clippy` and address warnings
- Write tests for new functionality
- Add rustdoc comments for public APIs
- Follow [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/)
## Commit Messages
We loosely follow [Conventional Commits](https://www.conventionalcommits.org/):
- `feat:` — New feature
- `fix:` — Bug fix
- `docs:` — Documentation changes
- `test:` — Adding or updating tests
- `refactor:` — Code changes that neither fix bugs nor add features
- `perf:` — Performance improvements
- `chore:` — Maintenance tasks
## Testing
We aspire to have test coverage on par with established crates like `tokio` and `serde`. When adding tests:
```rust
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_descriptive_name() {
// Arrange
// Act
// Assert
}
}
```
## Reporting Issues
When reporting issues, please include:
- Rust version (`rustc --version`)
- `gpui` version
- Minimal reproduction code
- Expected vs actual behavior
## Suggesting Features
We're open to feature suggestions! Please open an issue with:
- Use case description
- Proposed API (if applicable)
- Any prior art from TanStack Query or similar libraries
## Pull Request Process
1. Update documentation if needed
2. Add tests for new functionality
3. Ensure CI passes (tests, clippy, fmt)
4. Request review from maintainers
## License
By contributing, you agree that your contributions will be licensed under the MIT License:
```
MIT License
Copyright (c) 2024 DreamStack
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
## Questions?
Open an issue or reach out at [srihari@dreamstack.us](mailto:srihari@dreamstack.us).
---
Thanks again for your interest in contributing!