We’re excited you’re interested in contributing to Circuit Pro! Join the discussion and collaborate with others on our Discord Server.
Warning
Please do not submit localization-related pull requests at this time. We’ll announce when we’re ready for multilingual support and provide guidance here and on Discord.
Click the "Fork" button at the top right of the repository page. Once forked, clone your fork locally.
Check out the Issues tab or visit our project board to see what needs work.
Important
Comment on an issue or ask a maintainer to assign it to you before starting work, to avoid duplicated efforts. Some issues may be reserved for contributors familiar with specific areas of the code.
COMING SOON. Feel free to follow your own coding style for now.
Once your changes are ready, open a Pull Request (PR). A template will be provided — please fill it out completely.
Your PR should include:
- A clear title summarizing your changes.
- A detailed description of what was done and why.
- Screenshots or videos if UI was modified.
- A link to the related issue. If none exists, create one and reference it.
- Mark the PR as Draft if still in progress.
Request a review from one of our maintainers: @x33025.
Tip
If it’s your first PR, we’ll help guide you through the review process.
Important
Resolve all linting and test errors. PRs with failed checks will not be merged.
CI will run automated tests and linter checks. Fix any issues and resolve merge conflicts as needed.
Important
Document your code and leave helpful comments to assist other contributors!