Skip to content

Commit

Permalink
Update BrainFlowDev.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrey1994 committed Sep 17, 2019
1 parent 0aa419f commit 34b2aba
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/BrainFlowDev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ BrainFlow Dev
Code style
-----------

We are using clang-format tool to keep the same code style for all cpp files. You can download clang-format binary from `LLVM Download Page <http://releases.llvm.org/download.html>`_
We recommend to install a plugin for your text editor\IDE which will apply clang-format tool during saving. And you need to set "FILE" options
We use clang-format tool to keep the same code style for all cpp files. You can download clang-format binary from `LLVM Download Page <http://releases.llvm.org/download.html>`_
We recommend to install a plugin for your text editor or IDE which will apply clang-format tool during saving. You will need to set code style option to "FILE"

Plugins for text editors\IDEs:

Expand All @@ -17,15 +17,16 @@ Plugins for text editors\IDEs:
Unfortunately clang-format can not handle naming, so some additional rules are:
- methods and variables should be in lower case with underscore
- class names should be in camel case
- use brackets even for single line if and for statements

We are trying to keep the same code style for all bindings as well, even if it doesn't match PEP or other standards
We try to keep the same code style for all bindings as well, even if it doesn't match PEP or other standards

For example we add spaces before and after assignment operator to specify default value for method's param and add spaces before brackets

CI and tests
-------------

If you want to commit to core module of brainflow project please check that all tests are passed, you can enable `Travis CI <https://travis-ci.com/>`_ and `AppVeyour <https://ci.appveyor.com>`_ for your fork of BrainFlow to run tests automatically
If you want to commit to core module of brainflow project please check that all tests are passed, you can enable `Travis CI <https://travis-ci.com/>`_ and `AppVeyour <https://ci.appveyor.com>`_ for your fork of BrainFlow to run tests automatically, or check CI status directly in your PR

Pull Requests
--------------
Expand Down

0 comments on commit 34b2aba

Please sign in to comment.