-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into platformio_build
- Loading branch information
Showing
2 changed files
with
35 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,18 @@ | ||
# Contributing | ||
|
||
- New "apps" should be added as examples in the library (`library/examples/`) | ||
- Keep pull requests limited to a single thing (fixing an issue in an existing | ||
app, adding a new app, or fixing an issue in the library) | ||
- If modifying the library compile and flash the `HardwareDemo` example to | ||
ensure things still work | ||
|
||
## Coding standards | ||
|
||
- Keep clang-format happy | ||
- Member variables are prefixed with `m_` | ||
- Global variables are prefixed with `g_` | ||
- The order of declaration in class headers is (each of which should be in their | ||
own scope region, i.e. don't mix private variables and functions): | ||
- public constants | ||
- public functions | ||
- protected functions | ||
- private functions | ||
- protected variables | ||
- private variables |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters