docs/development/Development.md

   1 # Development
   2
   3 This document is primarily for developers.
   4 If you plan to contribute to Betaflight by opening a pull request for a bugfix or feature, please read the following text carefully before you start. This will help you in submitting your contribution in a form that has a good chance of being accepted. Please also read up on the [coding style](/docs/development/CodingStyle.md).
   5
   6 ## General principles
   7
   8 1. Name everything well.
   9 2. Strike a balance between simplicity and not-repeating code.
  10 3. Methods that start with the word 'find' can return a null, methods that start with 'get' should not.
  11 4. Keep methods short - it makes it easier to test.
  12 5. Don't be afraid of moving code to a new file - it helps to reduce test dependencies.
  13 6. Avoid noise-words in variable names, like 'data' or 'info'.  Think about what you're naming and name it well.  Don't be afraid to rename anything.
  14 7. Avoid comments that describe what the code is doing, the code should describe itself.  Comments are useful however for big-picture purposes and to document content of variables.
  15 8. If you need to document a variable do it at the declaration, don't copy the comment to the `extern` usage since it will lead to comment rot.
  16 9. Seek advice from other developers - know you can always learn more.
  17 10. Be professional - attempts at humor or slating existing code in the codebase itself is not helpful when you have to change/fix it.
  18 11. Know that there's always more than one way to do something and that code is never final - but it does have to work.
  19
  20 It is also advised to read about clean code, here are some useful links:
  21
  22 * http://cleancoders.com/
  23 * http://en.wikipedia.org/wiki/SOLID_%28object-oriented_design%29
  24 * http://en.wikipedia.org/wiki/Code_smell
  25 * http://en.wikipedia.org/wiki/Code_refactoring
  26 * http://www.amazon.co.uk/Working-Effectively-Legacy-Robert-Martin/dp/0131177052
  27
  28 ## Unit testing
  29
  30 Ideally, there should be tests for any new code. However, since this is a legacy codebase which was not designed to be tested this might be a bit difficult.
  31
  32 If you want to make changes and want to make sure it's tested then focus on the minimal set of changes required to add a test.
  33
  34 Tests currently live in the `test` folder and they use the google test framework.
  35 The tests are compiled and run natively on your development machine and not on the target platform.
  36 This allows you to develop tests and code and actually execute it to make sure it works without needing a development board or simulator.
  37
  38 This project could really do with some functional tests which test the behaviour of the application.
  39
  40 All pull requests to add/improve the testability of the code or testing methods are highly sought!
  41
  42 Note: Tests are written in C++ and linked with with firmware's C code. All code is also instrumented using gcov to make test coverage analysis possible.
  43
  44 ### Running the tests.
  45
  46 The tests and test build system is very simple and based off the googletest example files, it will be improved in due course. From the root folder of the project simply do:
  47
  48 ```
  49 make test
  50 ```
  51
  52 You can also do:
  53
  54 ```
  55 make junittest
  56 ```
  57
  58 This will build a set of executable files in the `obj/test` folder, one for each `*_unittest.cc` file.
  59 It will stop after first compile/build error. If you want it to continue with the next test module you can use `make -k test`.
  60
  61 After they have been executed by the make invocation, you can still run them on the command line to execute the tests and to see the test report. Test reports will also be produced in form of junit XML files, if tests are built and run with the "junittest" goal. Junit report files are saved in obj/test directory and has the following  naming pattern test\_name\_results.xml, for example: obj/test/battery\_unittest\_results.xml
  62
  63 You can also step-debug the tests in eclipse and you can use the GoogleTest test runner to make building and re-running the tests simple.
  64
  65 The tests are currently always compiled with debugging information enabled, there may be additional warnings, if you see any warnings please attempt to fix them and submit pull requests with the fixes.
  66
  67 Tests are verified and working with GCC 4.9.3
  68
  69 ## Using git and github
  70
  71 Ensure you understand the github workflow: https://guides.github.com/introduction/flow/index.html
  72
  73 Please keep pull requests focused on one thing only, since this makes it easier to merge and test in a timely manner.
  74
  75 If you need help with pull requests there are guides on github here:
  76
  77 https://help.github.com/articles/creating-a-pull-request/
  78
  79 The main flow for a contributing is as follows:
  80
  81 1. Login to github, go to the betaflight repository and press `fork`;
  82 2. Then using the command line/terminal on your computer: `git clone <url to YOUR fork>`;
  83 3. `cd betaflight`;
  84 4. `git checkout master`;
  85 5. `git checkout -b my-new-code`;
  86 6. Make changes;
  87 7. `git add <files that have changed>`;
  88 8. `git commit`;
  89 9. `git push origin my-new-code`;
  90 10. Create pull request using github UI to merge your changes from your new branch into `betaflight/master`;
  91 11. Repeat from step 4 for new other changes.
  92
  93 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.
  94
  95 Once you have created the PR,
  96 every new commit/push in your branch will propagate from your fork into the PR in the main github/betaflight repo.
  97 Checkout another branch first if you want something else.
  98
  99 Push will often fail if you edit or squash commits in a branch already pushed. Never do such things after creating the PR.
 100
 101 Later, you can get the changes from the betaflight repo into your `master` branch by adding betaflight as a git remote and merging from it as follows:
 102
 103 1. `git remote add betaflight https://github.com/betaflight/betaflight.git`
 104 2. `git checkout master`
 105 3. `git fetch betaflight`
 106 4. `git merge betaflight/master`
 107 5. `git push origin master` is an optional step that will update your fork on github
 108
 109 You can also perform the git commands using the git client inside Eclipse.  Refer to the Eclipse git manual.
 110
 111 ### Providing Test Targets for Pull Requests
 112
 113 If you open a pull request for the betaflight repository that contains a change that can be tested by other users, please build a set of test firmware files for all Unified Targets and attach them to the pull request. The required firmware files can be built in zipped form ready for upload to GitHub with `make unified_zip`. When attaching test firmware files, you can point users to this video for instructions on how to install the test firmware: https://youtu.be/I1uN9CN30gw
 114
 115 Example of a pull request with test firmware attached:
 116
 117 ![Pull request with test targets](assets/pull_request_test_targets.png)
 118
 119 ### IDEs and .gitignore
 120
 121 The projects [.gitignore](/.gitignore) already ignores certain artifacts from some IDEs, but if you'd like to use something else, you can set up git to ignore the necessary files at a global level (all git projects on the computer)
 122
 123 It is always good to check that you haven't done this already: `git config --global --get core.excludesfile`
 124
 125 For Linux/BSD/OSX: `git config --global core.excludesfile '~/.gitignore'`
 126
 127 For Windows: `git config --global core.excludesfile '%USERPROFILE%\.gitignore'`
 128
 129 When you `git config --global --get core.excludesfile` a second time, you should get a file location back.