diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-09-03 11:01:00 +0200 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-09-03 11:01:00 +0200 |
| commit | 690c853da8b50faa366ff42d9b32b32c841e7211 (patch) | |
| tree | a2343570435e75bfd37025c3cedff3aceb033a53 /contributing.md | |
| parent | ff078630f3420a03cf8d9432cc7a96f249db5573 (diff) | |
more scaffolding
Diffstat (limited to 'contributing.md')
| -rw-r--r-- | contributing.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..c018917 --- /dev/null +++ b/contributing.md @@ -0,0 +1,29 @@ +# Contributing new code + +- Please do the following *before* sending a pull request: + - Merge upstream code (if any) back into your own branch + - Run formatters/linters + +# Git + +- TODO: tagging / versions +- TODO: branch stability / gitflow? + +# Code style + +- Formatting nitty-gritty is handled by clang-format/clang-tidy +- ASCII only +- 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). + +# Documentation + +- All documentation is written in U.S. English +- TODO + +# Libraries + +- External libraries should be included as Git submodules under the `lib/` + subdirectory + |