Skip to Content
CommunityContributing

Contributing guide

Ways to help

  1. Documentation — fix typos, add screenshots, clarify install steps (m2c2-docs ).
  2. Core — bug fixes and features in magicmirror2os with tests where possible.
  3. Addons — publish to the Marketplace.

Pull request checklist

  1. Describe motivation — what user pain is solved?
  2. Scope — avoid drive-by refactors mixed with features.
  3. Test on Pi for hardware-affected changes (camera, GPIO, audio).
  4. License — contribute under the project’s SPDX license.

💡 Tip: For docs-only PRs, include before/after screenshots if you change UX-heavy instructions.

Code of conduct

Be respectful in issues and reviews — assume good intent, cite evidence, avoid pile-ons.

Last updated on

Was this helpful?