Skip to content

Development guide

Jump to bottom
daviderovell0 edited this page Mar 24, 2020 · 3 revisions

A couple of development guidelines to contribute to the bzzzbz project.

Development environment

Since the core controller of the system is a RaspberryPi running Raspbian (Debian) operating system, we advise to use any Linux distro to be able to better replicate the system environment in your local machine.
The video generation algorithms use OpenGL, please refer to the README for third party dependencies.
I personally find it useful to use a graphical git client to handle branching, merging and rebasing (often useful for this repo). Good (free) examples are GitCola (Linux) and GitExtensions (Windows).

Making changes to the source

Changes to the master branch require approval through PR review (it is therefore impossible to push directly to master).

  • Create (or checkout) a branch from the latest master
  • If you checkout make sure to pull as it avoids a lot of merging issues later
  • Write your contribution
  • Push your local changes to the corresponding remote branch
  • Create a Pull Request (PR) with detailed description.
  • Wait for another contributor to review and approve your changes
  • Merge to master.

daviderovell0

Clone this wiki locally