Contributing to BioQuery

Thank you for your interest in contributing to BioQuery!

Getting Started

1. Fork the repository you want to contribute to
2. Clone your fork locally
3. Create a feature branch: git checkout -b feature/your-feature
4. Make your changes
5. Commit with a clear message: git commit -m "feat: add new feature"
6. Push to your fork: git push origin feature/your-feature
7. Open a Pull Request

Commit Messages

We follow Conventional Commits:

• feat: - New features
• fix: - Bug fixes
• docs: - Documentation changes
• style: - Code style changes (formatting, etc.)
• refactor: - Code refactoring
• test: - Adding or updating tests
• chore: - Maintenance tasks

Pull Request Guidelines

• Keep PRs focused on a single change
• Update documentation if needed
• Add tests for new functionality
• Ensure all tests pass
• Follow the existing code style

Code Style

Python (API, SDK)

• Format with Black
• Sort imports with isort
• Type hints required
• Lint with ruff

TypeScript (Frontend, Docs)

• Format with Prettier
• Lint with ESLint
• Use TypeScript strict mode

Questions?

• Open a GitHub issue
• Email: hello@bioquery.io