Contributing¶

Thank you for your interest in contributing to qldata!

Documentation Repository¶

This documentation is hosted at github.com/ZENTCH-Q/qldata-docs.

Ways to Contribute¶

📝 Documentation¶

• Fix typos or unclear explanations
• Add examples and recipes
• Improve API documentation
• Translate documentation

🐛 Bug Reports¶

Found an issue? Please report it:

1. Check existing issues first
2. Provide a minimal reproducible example
3. Include Python version and qldata version
4. Describe expected vs actual behavior

💡 Feature Requests¶

Have an idea? We'd love to hear it:

1. Check if it's already requested
2. Describe the use case
3. Propose an API design (optional)

Development Setup¶

# Clone the repository
git clone https://github.com/ZENTCH-Q/qldata-docs.git
cd qldata-docs

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # or .venv\Scripts\activate on Windows

# Install dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Build docs locally
mkdocs serve

Code Style¶

We use:

• Black for formatting
• Ruff for linting
• mypy for type checking

# Format code
black src tests

# Lint
ruff check src tests

# Type check
mypy src

Pull Request Process¶

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run tests (pytest)
5. Run linting (ruff check && black --check)
6. Commit with a clear message
7. Push and create a Pull Request

Documentation Style¶

When writing documentation:

• Use clear, concise language
• Include code examples for every feature
• Add type hints to all function signatures
• Use admonitions for important notes

!!! note "Title"
    Content here

!!! warning
    Important warning

!!! tip
    Helpful tip

License¶

By contributing, you agree that your contributions will be licensed under the MIT License.

Questions?¶

• Open a GitHub issue
• Check existing documentation

Thank you for contributing! 🎉