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 -----------
  20 - Your code must build
  21 - Commits must have a sign-off line by at least yourself
  22 - Commits must be named <file/module>: Some decent description
  23 - Try not to break master. In any commit.
  24 - Try to split commits up logically, you will be asked to rebase them if they
  25   are not.
  26 - Try to stick to the established coding style reguardless of your personal feeling for it!
  27
  28 Code signing
  29 ------------
  30
  31 The sign-off is a simple line at the end of the explanation for the
  32 patch, which certifies that you wrote it or otherwise have the right to pass it
  33 on as an open-source patch.  The rules are pretty simple: if you can certify
  34 the below:
  35
  36         Developer's Certificate of Origin 1.1
  37
  38         By making a contribution to this project, I certify that:
  39
  40         (a) The contribution was created in whole or in part by me and I
  41             have the right to submit it under the open source license
  42             indicated in the file; or
  43
  44         (b) The contribution is based upon previous work that, to the best
  45             of my knowledge, is covered under an appropriate open source
  46             license and I have the right under that license to submit that
  47             work with modifications, whether created in whole or in part
  48             by me, under the same open source license (unless I am
  49             permitted to submit under a different license), as indicated
  50             in the file; or
  51
  52         (c) The contribution was provided directly to me by some other
  53             person who certified (a), (b) or (c) and I have not modified
  54             it.
  55
  56         (d) I understand and agree that this project and the contribution
  57             are public and that a record of the contribution (including all
  58             personal information I submit with it, including my sign-off) is
  59             maintained indefinitely and may be redistributed consistent with
  60             this project or the open source license(s) involved.
  61
  62 then you just add a line saying
  63
  64         Signed-off-by: Random J Developer <random@developer.example.org>
  65
  66 Using your real name (sorry, no pseudonyms or anonymous contributions.)