docs/contributing.md

   1 Contributing to libmraa                           {#contributing}
   2 ======================
   3
   4 libmraa is an opensource project and we are actively looking for people to help
   5 with:
   6
   7 - Writing platform supports for all types of embedded boards running linux
   8 - People to write cool samples
   9 - People to extend the functionality
  10
  11 The recommended method to contribute is to fork on github, and then send pull
  12 requests to the main project. Questions can be also be asked and issues raised
  13 on github.
  14
  15 If you'd rather not use github you are more than welcome to send git formatted
  16 patches to brendan.le.foll@intel.com.
  17
  18 # Basic rules
  19 - Your code must build
  20 - Commits must have a sign-off line by at least yourself
  21 - Commits must be named <file/module>: Some decent description
  22 - Try not to break master. In any commit.
  23 - Try to split commits up logically, you will be asked to rebase them if they
  24   are not.
  25 - Try to stick to the established coding style reguardless of your personal feeling for it!