Contributing guide
StormBreaker is built by volunteers, and we’d love your help. Whether you write kernel code, test builds on your device, improve docs, or just file good bug reports — it all counts. Here’s how to get started.
Ways to contribute
- Code — fix bugs, port features, or maintain a device kernel.
- Testing — flash builds, report regressions, share logs.
- Docs — improve READMEs, guides, or this website.
- Triage — help reproduce and label issues.
Before you start
- Read our Code of Conduct — it applies everywhere.
- Skim the maintainer guidelines.
- Say hi on Telegram or Discord if you’re unsure where to begin.
Submitting changes
- Fork the relevant repo under github.com/stormbreaker-project.
- Create a branch:
git checkout -b fix/short-description. - Keep commits focused and write clear messages (imperative mood, e.g. “Fix wakeup regression”).
- Test your build on-device before opening a PR.
- Open a pull request describing what changed and why, with logs if relevant.
Reporting bugs & requesting devices
Open an issue on the appropriate repo with your device, build, steps to reproduce, and a
dmesg/logcat if you have one. Device requests are welcome — the more testers
a device has, the more likely it gets picked up.
Thanks for helping make StormBreaker better. ⚡