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) - Reviews: When a reviewer requests changes, re-request a review once the PR is ready again; see Review process
- Contributing guide -- full development workflow
- Coding conventions -- style and standards
- Issue triage process -- how issues are tracked and prioritised
- DiracX documentation -- full documentation site