Skip to content

Contributing

SpoolmanScale is open-source and contributions are welcome — whether it's code, documentation, bug reports, or feature ideas.

Ways to Contribute

  • Bug reports — open an issue on GitHub
  • Feature requests — open an issue or discuss on Discord
  • Code — open a Pull Request
  • Documentation — fix errors or add missing content in the Docs repo
  • Testing — try beta firmware and report findings on Discord

Code Contributions

Setup

git clone https://github.com/Niko11111/SpoolmanScale.git
cd SpoolmanScale

Open in VS Code with PlatformIO extension installed.

Guidelines

  • All code comments in English
  • All UI strings via T(STR_XXX) macro — never hardcoded
  • Test on real hardware before submitting a PR
  • One change per PR — keep it focused

Pull Request Process

  1. Fork the repo
  2. Create a branch: git checkout -b feature/my-feature
  3. Make your changes
  4. Push and open a PR against main

Documentation Contributions

The docs are in a separate repo. Just edit the .md files and open a PR — no build step needed to submit.

Support the Project

If you find SpoolmanScale useful, consider supporting it:

☕ ko-fi.com/formfollowsfunction

A like on MakerWorld and a ⭐ on GitHub also help a lot!