summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorBastiaan Olij <mux213@gmail.com>2018-11-24 09:09:41 +1100
committerBastiaan Olij <mux213@gmail.com>2018-11-24 09:09:41 +1100
commitfc20fa3fce2f30c96fa2bbf8d460817f91b90e81 (patch)
treedecd51288822651ad34fd270e68a2f2a54d0bd8d /README.md
parent0a6f5d052a0d05e07ca1b7eab8e53bbd8450a991 (diff)
downloadredot-cpp-fc20fa3fce2f30c96fa2bbf8d460817f91b90e81.tar.gz
Implementing clang-format and applying it to all classes
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1c917be..a1dec84 100644
--- a/README.md
+++ b/README.md
@@ -9,9 +9,18 @@ Version | Branch
**Godot 3.1 Nativescript 1.0** | [nativescript-1.0](https://github.com/GodotNativeTools/godot-cpp/tree/nativescript-1.0)
Index:
+- [**Contributing**](#contributing)
- [**Getting Started**](#getting-started)
- [**Creating a simple class**](#creating-a-simple-class)
+## Contributing
+We greatly appreciate help in maintaining and extending this project.
+If you wish to help out ensure you have an account on Github and create a "fork" of the this repo.
+RĂ©mi "Akien" Verschelde wrote an excellent bit of documentation for the main Godot project on this:
+https://docs.godotengine.org/en/3.0/community/contributing/pr_workflow.html
+
+It is advisible to also install clang-format and copy the files in `misc/hooks` into `.git/hooks` so format checking is done before your changes are submitted.
+
## Getting Started
| **Build latest version of Godot** | [**GitHub**](https://github.com/godotengine/godot) | [**Docs**](https://godot.readthedocs.io/en/latest/development/compiling/index.html) |