Skip to content

Latest commit

 

History

History
20 lines (16 loc) · 1.08 KB

CONTRIBUTING.md

File metadata and controls

20 lines (16 loc) · 1.08 KB

Contributing to Project

All contributions (PRs) have to be done towards develop branch. If a feature or bugfix is a major change please contact me to prepare feature specific handling.

master: Branch that contains latest production (stable) release. No PRs other than firmware releases will be merged into master.
develop: Main development branch: contains latest features and fixes.

This will mean that all contributors will have to submit a PR to develop , it will be tested and then merged to develop for automated integration testing (via TravisCI), as well as manual testing on a real device.

Project Contributing flow:

  • Fork repository
  • Create a branch off develop (name it feature/mynewfeature or fix/myfix)
  • Build, test your code against a real device
  • Commit changes
  • Push your changes to your fork on github
  • Submit PR to the main repo, develop branch.
  • Work with other contributors to test your feature and get it merged to develop

This is the most common approach for a git-flow: http://nvie.com/posts/a-successful-git-branching-model/