diff options
| author | Riku Isokoski <riksu9000@gmail.com> | 2021-08-14 20:02:23 (GMT) |
|---|---|---|
| committer | Riku Isokoski <riksu9000@gmail.com> | 2021-08-14 20:02:23 (GMT) |
| commit | 044036e884039237ade739d46b682e586a36e8df (patch) | |
| tree | af50c3194a86096147459bc9b4d5821b8bd509d2 /CONTRIBUTING.md | |
| parent | 23bde0d18e99a344b95b5f1507350e186659eec2 (diff) | |
| parent | df8d396472fe47016623a111a5f025048fb82964 (diff) | |
Merge branch 'develop' into timer_battery_reading
Diffstat (limited to 'CONTRIBUTING.md')
| l---------[-rw-r--r--] | CONTRIBUTING.md | 34 |
1 files changed, 1 insertions, 33 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a6fa682..15e2c68 100644..120000 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,33 +1 @@ -This contribution guide is in progress, improvements are welcome. - -### Code style - -Any C++ code PRs should aim to follow the style of existing code in the project. - -Using an autoformatter is heavily recommended, but make sure it's configured properly. - -There's currently preconfigured autoformatter rules for: - - * CLion (IntelliJ) in .idea/codeStyles/Project.xml - -You can use those to configure your own IDE if it's not already on the list. - -#### Linting errors and compiler warnings - -Try to avoid any currently enabled warnings and try to reduce the amount of linter errors. - -#### Spelling - -Make sure you spellcheck your code before commiting it. - -#### TODO, FIXME - -Check before commiting that you haven't forgotten anything, preferably don't leave these in your commits. - -#### Licence headers - -You should add your name to the comma-space separated list of contributors if there's a license header. - -### License - -By contributing you agree to licence your code under the repository's general license (which is currently GPL-v3+). +doc/contribute.md
\ No newline at end of file |