Thanks for your interest in contributing! This guide will help you get started.
The DiracX contributing guide covers the full development workflow, including setting up your environment, making changes, and submitting pull requests. The getting started tutorial walks through setting up a local development environment.
If you're looking for something to work on, check out issues labelled "good first issue".
- Commits: Use Conventional Commits format (
feat:,fix:,docs:, etc.) - Branches: Name your branch descriptively, e.g.
feat/add-widgetorfix/login-error - PRs: Reference the related issue in your PR description (
Closes #123)
PRs are reviewed by project maintainers. Here's how the process works:
- Open your PR and mark it as Ready for review when it's complete.
- A reviewer will be assigned and will review your changes.
- If a reviewer requests changes, the PR is automatically converted to a draft. This signals that it's back in your hands.
- Address the feedback, push your updates, and mark the PR as Ready for review again.
- A daily digest of open PRs is posted to ensure nothing gets forgotten.
- Contributing guide -- full development workflow
- Coding conventions -- style and standards
- Issue triage process -- how issues are tracked and prioritised
- DiracX documentation -- full documentation site