How to Contribute¶
SpoolSense is open source (GPL-3.0) and welcomes contributions. Here's how to help.
Ways to Contribute¶
Report Bugs¶
Found something broken? Open an issue with:
- What you expected to happen
- What actually happened
- Steps to reproduce
- Your hardware (board, NFC reader, tag type)
- Firmware version (shown on the landing page)
Test and Give Feedback¶
Build a scanner, try it out, tell us what works and what doesn't. Even "it just worked" is helpful feedback.
Write Documentation¶
This site is built from Markdown files in the spoolsense.org repo. Fork it, edit, and open a PR.
Design an Enclosure or Mod¶
We need printable cases, mounts, and mods. See Enclosure Design for what's needed, or browse existing Community Mods. Designs are submitted to the scanner repo's usermods/ directory.
Contribute Code¶
See Development Setup to get started with the codebase.
Repositories¶
| Repo | Language | What to Work On |
|---|---|---|
| spoolsense_scanner | C++ (Arduino) | Firmware, NFC, web UI |
| spoolsense_middleware | Python | Klipper/AFC integration |
| spoolsense-installer | Python/Bash | Setup experience |
| spoolsense.org | Markdown | Documentation |
Workflow¶
- Fork the repo
- Create a branch from
dev(notmain) - Make your changes
- Open a PR targeting
dev - CodeRabbit will auto-review your PR
main is the production branch. All work goes through dev first.