diff options
| author | Max Hilbrunner <mhilbrunner@users.noreply.github.com> | 2018-10-14 19:30:22 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-10-14 19:30:22 +0200 |
| commit | 000307f255d412be2765d1f1e0ec40a142b1becc (patch) | |
| tree | 197f021cb123cae4d34311b2d7700c0b7fc67a90 | |
| parent | 73e22a7cee43c397bfd8ec00466ceb9105ec8ff4 (diff) | |
| parent | 172694ac4ca5aac60b82a354cfb491bc545c8914 (diff) | |
Merge pull request #23001 from voithos/contributingdoc
Add useful links for contributors to CONTRIBUTING and README docs.
| -rw-r--r-- | CONTRIBUTING.md | 10 | ||||
| -rw-r--r-- | README.md | 4 |
2 files changed, 10 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 68ec20a525..2ea2ed6bba 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,11 +70,15 @@ Similar rules can be applied when contributing bug fixes - it's always best to discuss the implementation in the bug report first if you are not 100% about what would be the best fix. +In addition to the following tips, also take a look at the +[Engine development guide](http://docs.godotengine.org/en/latest/development/cpp/) +for an introduction to developing on Godot. + #### Be nice to the git history -Try to make simple PRs with that handle one specific topic. Just like for -reporting issues, it's better to open 3 different PRs that each address a -different issue than one big PR with three commits. +Try to make simple PRs that handle one specific topic. Just like for reporting +issues, it's better to open 3 different PRs that each address a different issue +than one big PR with three commits. When updating your fork with upstream changes, please use ``git pull --rebase`` to avoid creating "merge commits". Those commits unnecessarily pollute the git @@ -40,7 +40,7 @@ Official binaries for the Godot editor and the export templates can be found [See the official docs](http://docs.godotengine.org/en/latest/development/compiling/) for compilation instructions for every supported platform. -### Community +### Community and contributing Godot is not only an engine but an ever-growing community of users and engine developers. The main community channels are listed [on the homepage](https://godotengine.org/community). @@ -49,6 +49,8 @@ To get in touch with the developers, the best way is to join the [#godotengine IRC channel](https://webchat.freenode.net/?channels=godotengine) on Freenode. +To get started contributing to the project, see the [contributing guide](CONTRIBUTING.md). + ### Documentation and demos The official documentation is hosted on [ReadTheDocs](http://docs.godotengine.org). |