diff options
Diffstat (limited to 'contributing.md')
| -rw-r--r-- | contributing.md | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/contributing.md b/contributing.md index 0c24560..5cbad61 100644 --- a/contributing.md +++ b/contributing.md @@ -17,8 +17,9 @@ # Code style -- Formatting nitty-gritty is handled by clang-format/clang-tidy - ASCII only +- Formatting nitty-gritty is handled by clang-format/clang-tidy (run `make + format` in the root folder of this repository to format all sources files) - When using libraries of which the header include order is important, make sure to separate the include statements using a blank line (clang-format may sort include statements, but does not sort across empty lines). @@ -247,13 +248,11 @@ draw_load_screen(); # Documentation - All documentation is written in U.S. English -- [stanford latex style](https://web.stanford.edu/class/ee364b/latex_templates/template_notes.pdf) -- TODO # Libraries - External libraries should be included as Git submodules under the `lib/` subdirectory -- When adding new submodules, make sure to manually set the `branch` and - `shallow` options in the [.gitmodules](./.gitmodules) file +- When adding new submodules, please set the `shallow` option to `true` in the + [.gitmodules](./.gitmodules) file |