diff options
| author | hubmartin <hub.martin@gmail.com> | 2021-08-22 22:11:57 +0200 |
|---|---|---|
| committer | hubmartin <hub.martin@gmail.com> | 2021-08-22 22:11:57 +0200 |
| commit | 2a299fe2759e934c69b360995745d43c741115f8 (patch) | |
| tree | 83813367684eba510da5d5295aca476151b545f3 /CONTRIBUTING.md | |
| parent | 0d083a2beac118234f07dacee42f0925420abb42 (diff) | |
| parent | df8ea7fe523bb9ec0ac3e24f0b1bebe5743d90cc (diff) | |
Merge branch 'develop' into pinmap
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 a6fa6828..15e2c684 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 |