CONTRIBUTING.md

   1 # Contributing
   2
   3 Please see the Contributing section of the README.md
   4
   5 Please see the docs/developers folder for other notes.
   6
   7 Ensure you understand the github workflow: https://guides.github.com/introduction/flow/index.html
   8
   9 Please keep pull requests focused on one thing only, since this makes it easier to merge and test in a timely manner.
  10
  11 If you need help with pull requests there are guides on github here:
  12
  13 https://help.github.com/articles/creating-a-pull-request/
  14
  15 The main flow for a contributing is as follows:
  16
  17 1. Login to github, goto the cleanflight repository and press `fork`.
  18 2. `git clone <url to YOUR fork>`
  19 3. `cd cleanflight`
  20 4. `git checkout master`
  21 5. `git checkout -b my-new-code`
  22 6. Make changes
  23 7. `git add <files that have changed>`
  24 8. `git commit`
  25 9. `git push origin my-new-code`
  26 10. Create pull request using github UI to merge your changes from your new branch into `cleanflight/master`
  27 11. Repeat from step 4 for new other changes.
  28
  29 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.
  30
  31 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:
  32
  33 1. `git add remote cleanflight https://github.com/cleanflight/cleanflight.git`
  34 2. `git checkout master`
  35 3. `git fetch cleanflight`
  36 4. `git merge cleanflight/master`
  37