Bläddra i källkod

Add useful links for contributors to CONTRIBUTING and README docs.

Zaven Muradyan 6 år sedan
förälder
incheckning
172694ac4c
2 ändrade filer med 10 tillägg och 4 borttagningar
  1. 7 3
      CONTRIBUTING.md
  2. 3 1
      README.md

+ 7 - 3
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

+ 3 - 1
README.md

@@ -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).