Skip to content
This repository has been archived by the owner on May 26, 2022. It is now read-only.

Latest commit

 

History

History
32 lines (26 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

32 lines (26 loc) · 1.48 KB
Raw

How to help?

I consider the service and message passing interface more-or-less stable and don't expect breaking changes. I'd be happy to receive a help in:

  • Code review
  • Performance improvements
  • Fixing FIXMEs and TODOs
  • Cross-compilation for different boards
  • New service implementation or its API documentation
  • Writing the user documentation

Workflow

  • Latest code is always in master
  • I commit directly to master because I don't care – and because I often run make check locally
  • Feature branches get deleted after merging
  • No release branches, flat commit history
  • Releases get tagged with annotated tags
  • CHANGELOG.md is really maintained
  • Semantic Versioning is used, well… before 1.0.0 – not really
  • Refer to issues in commit messages. Sometimes I personally forget to do that though

Principles

  • Clean code, because it's a learning project
  • Stability, it should «just work»
  • Easy installation on Raspberry Pi
  • Good performance on Raspberry Pi Zero W
  • No plugins, «batteries included»
  • Little configuration, good defaults, automatically discover peripherals and network devices where possible
  • Unit tests where applicable, don't be obsessed with them though
  • Don't repeat yourself more than a few times