Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

All modules and drivers should have a simple, common API which can easily be ported across multiple platforms. Our drivers are designed to abstract most of the heavy lifting away from the user, allowing the development of systems without needing to worry about the inner workings of each component.

Version Control

We use git for our version control. There are a number of resources available for git, such as this simple guide.

Our firmware is stored on GitHub as an open-source project. To get involved, please speak to a software lead to be added to our GitHub organization.

In general, we follow the basic git flow. The master branch should contain stable, vetted code. Development branches should be created on a feature-by-feature basis, and a pull request to master should be created when the feature is complete. Please squash your branch before merging to master.

Coding Style

At Midnight Sun, we use a variant of the Google C++ Style Guide. In general:

...