diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4eefb46043f..c350e210805 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,8 @@ Such fix commits should ideally be squashed into one big commit using ``git comm A lot of the style offenses can be fixed automatically by running the fix script `./scripts/fix_style.py` +We use clang-format 10. If your package manager no longer provides this version, you can download it from https://pypi.org/project/clang-format/10.0.1.1/. + ### Upper camel case for variables, methods, class names With the exception of base/system.{h,cpp} diff --git a/README.md b/README.md index 779467b98b1..ab13f4c1b1a 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ You can get binary releases on the [DDNet website](https://ddnet.org/downloads/) - [Code Browser](https://ddnet.org/codebrowser/DDNet/) - [Source Code Documentation](https://codedoc.ddnet.org/) (very incomplete, only a few items are documented) +- [Contributing Guide](CONTRIBUTING.md) If you want to learn about the source code, you can check the [Development](https://wiki.ddnet.org/wiki/Development) article on the wiki.