Thank you for your interest in contributing to RushDB! To ensure a smooth contribution process, please follow the checklist below when reporting issues or submitting changes.
When reporting an issue, include the following information:
- Minimum Reproducible Data Set
- Provide a small JSON or CSV dataset if the issue is related to the core, dashboard, or SDK.
- Ensure the dataset highlights the problem clearly.
- RushDB Version
- Specify the version of RushDB you are using:
- Cloud: Mention if you are using the latest cloud version.
- Self-hosted: Provide the tag from Docker Hub or the SDK version.
- Steps to Reproduce
- Give a detailed explanation of how to reproduce the issue.
- Include any configurations, commands, or environment settings.
- Query Examples
- If applicable, include specific queries that trigger the error.
- Minimum Repository (if SDK-related)
- For issues related to the SDK, a minimal GitHub repository demonstrating the bug may be required.
Before submitting a pull request:
- Ensure your code adheres to the project's coding standards.
- Include unit tests for new functionality or bug fixes.
- Update documentation if necessary.
For urgent issues or further assistance, you can reach out directly:
- Telegram: tg:onepx
- LinkedIn: linkedin.com/onepx
We appreciate your contributions and look forward to your feedback!
# Install dependencies
uv sync --dev# Check import sorting
uv run isort . --check# Type checking
uv run mypy src/rushdb# Code formatting
uv run black .# Linting
uv run ruff check .# Run tests
uv run pytest# Run tests with coverage
uv run pytest --cov