CONTRIBUTING.md

   1 # Issues and Support.
   2
   3 Please remember the issue tracker on github is _not_ for user support.  Please also do not email developers directly for support.  Instead please use IRC or the forums first, then if the problem is confirmed create an issue that details how to repeat the problem so it can be investigated.
   4
   5 Issued created without steps to repeat are likely to be closed.  E-mail requests for support will go un-answered.
   6
   7 Remember that issues that are due to mis-configuration, wiring or failure to read documentation just takes time away from the developers and can often be solved without developer interaction by other users.
   8
   9 Please search for existing issues *before* creating new ones.
  10
  11 # Developers
  12
  13 Please see the Contributing section of the README.md
  14
  15 Please see the docs/developers folder for other notes.
  16
  17 Ensure you understand the github workflow: https://guides.github.com/introduction/flow/index.html
  18
  19 Please keep pull requests focused on one thing only, since this makes it easier to merge and test in a timely manner.
  20
  21 If you need help with pull requests there are guides on github here:
  22
  23 https://help.github.com/articles/creating-a-pull-request/
  24
  25 The main flow for a contributing is as follows:
  26
  27 1. Login to github, goto the cleanflight repository and press `fork`.
  28 2. Then using the command line/terminal on your computer: `git clone <url to YOUR fork>`
  29 3. `cd cleanflight`
  30 4. `git checkout master`
  31 5. `git checkout -b my-new-code`
  32 6. Make changes
  33 7. `git add <files that have changed>`
  34 8. `git commit`
  35 9. `git push origin my-new-code`
  36 10. Create pull request using github UI to merge your changes from your new branch into `cleanflight/master`
  37 11. Repeat from step 4 for new other changes.
  38
  39 The primary thing to remember is that separate pull requests should be created for separate branches.  Never create a pull request from your `master` branch.
  40
  41 Later, you can get the changes from the cleanflight repo into your `master` branch by adding cleanflight as a git remote and merging from it as follows:
  42
  43 1. `git add remote cleanflight https://github.com/cleanflight/cleanflight.git`
  44 2. `git checkout master`
  45 3. `git fetch cleanflight`
  46 4. `git merge cleanflight/master`
  47
  48
  49 You can also perform the git commands using the git client inside Eclipse.  Refer to the Eclipse git manual.
  50