Merge pull request ddnet#9412 from BlaiZephyr/extend_readme_contributing

extend CONTRIBUTING.md and README.md
sjrc6 · Dec 20, 2024 · 2012937 · 2012937
2 parents 168391f + 1326deb
commit 2012937
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git 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
@@ -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.