diff options
| author | heavydemon21 <nielsstunnebrink1@gmail.com> | 2024-10-01 11:05:42 +0200 |
|---|---|---|
| committer | heavydemon21 <nielsstunnebrink1@gmail.com> | 2024-10-01 11:05:42 +0200 |
| commit | 8e66301577551bc5b8a2e169be173e71de2f5e4e (patch) | |
| tree | 52797ebfe53007eaf502c9cf9aafbd34817f5d0b /contributing.md | |
| parent | 2d13805218eb34b6e06205c1b65c341ebcdad504 (diff) | |
| parent | f4560e02f703f1c6f857c8e5af63fa9fc4ca6438 (diff) | |
Merge branch 'master' into niels/resource-manager
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 |