Improve contribution guidelines

Docs/CONTRIBUTING.md

@@ -1,23 +1,25 @@
 Contributing to CARLA
 =====================
 
-> _This document is a work in progress and might be incomplete._
-
 We are more than happy to accept contributions!
 
 How can I contribute?
 
   * Reporting bugs
   * Feature requests
+  * Improving documentation
   * Code contributions
 
 Reporting bugs
 --------------
 
-Use our [issue section](issueslink) on GitHub. Please check before that the
-issue is not already reported.
+Use our [issue section][issueslink] on GitHub. Please check before that the
+issue is not already reported, and make sure you have read our
+[Documentation][docslink] and [FAQ][faqlink].
 
 [issueslink]: https://github.com/carla-simulator/carla/issues
+[docslink]: http://carla.readthedocs.io
+[faqlink]: http://carla.readthedocs.io/en/latest/faq/
 
 Feature requests
 ----------------
@@ -28,6 +30,28 @@ your request as a new issue.
 
 [frlink]: https://github.com/carla-simulator/carla/issues?q=is%3Aissue+is%3Aopen+label%3A%22feature+request%22
 
+Improving documentation
+-----------------------
+
+If you feel something is missing in the documentation, please don't hesitate in
+opening an issue to let us know.
+
+Even better, if you think you can improve it yourself it would be a great
+contribution to the community!
+
+We build our documentation with [MkDocs](http://www.mkdocs.org/) based on the
+Markdown files inside the "Docs" folder. You can either directly modify them on
+GitHub or locally in your machine.
+
+Once you are done with your changes, please submit a pull-request against the
+`documentation` branch.
+
+**TIP:** You can build and serve it locally by running `mkdocs` in the project's
+main folder
+
+    $ sudo pip install mkdocs
+    $ mkdocs serve
+
 Code contributions
 ------------------
 
@@ -52,25 +76,8 @@ current documentation if you feel confident enough.
 
 #### Coding standard
 
-Please follow the current coding style when submitting new code.
-
-###### General
-
-  * Use spaces, not tabs.
-  * Avoid adding trailing whitespace as it creates noise in the diffs.
-  * Comments should not exceed 80 columns, code may exceed this limit a bit in rare occasions if it results in clearer code.
-
-###### Python
-
-  * All code must be compatible with Python 2.7, 3.5, and 3.6.
-  * [Pylint](https://www.pylint.org/) should not give any error or warning (few exceptions apply with external classes like `numpy`, see our `.pylintrc`).
-  * Python code follows [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/) (use `autopep8` whenever possible).
-
-###### C++
-
-  * Compilation should not give any error or warning (`clang++ -Wall -Wextra -std=C++14`).
-  * Unreal C++ code (CarlaUE4 and Carla plugin) follow the [Unreal Engine's Coding Standard](https://docs.unrealengine.com/latest/INT/Programming/Development/CodingStandard/) with the exception of using spaces instead of tabs.
-  * CarlaServer uses [Google's style guide](https://google.github.io/styleguide/cppguide.html).
+Please follow the current [coding standard](coding_standard.md) when submitting
+new code.
 
 #### Pull-requests
 
@@ -78,8 +85,25 @@ Once you think your contribution is ready to be added to CARLA, please submit a
 pull-request to the `dev` branch.
 
 Try to be as descriptive as possible when filling the pull-request description.
+Adding images and gifs may help people to understand your changes or new
+features.
 
 Please note that there are some checks that the new code is required to pass
 before we can do the merge. The checks are automatically run by the continuous
 integration system, you will see a green tick mark if all the checks succeeded.
 If you see a red mark, please correct your code accordingly.
+
+###### Checklist
+
+<!--
+  If you modify this list please keep it up-to-date with pull_request_template.md
+-->
+
+  - [ ] Make sure you are making a pull request against the `dev` branch (not `master` please)
+  - [ ] Your branch is up-to-date with `dev` branch and tested with latest changes
+  - [ ] Extended the README / documentation, if necessary
+  - [ ] Code compiles correctly
+  - [ ] All tests passing
+    - [ ] `make check`
+    - [ ] `pylint --disable=R,C --rcfile=PythonClient/.pylintrc PythonClient/carla PythonClient/*.py`
+    - [ ] `cppcheck . -iBuild -i.pb.cc --enable=warning`

Docs/coding_standard.md

@@ -0,0 +1,25 @@
+Coding standard
+===============
+
+> _This document is a work in progress and might be incomplete._
+
+General
+-------
+
+  * Use spaces, not tabs.
+  * Avoid adding trailing whitespace as it creates noise in the diffs.
+  * Comments should not exceed 80 columns, code may exceed this limit a bit in rare occasions if it results in clearer code.
+
+Python
+------
+
+  * All code must be compatible with Python 2.7, 3.5, and 3.6.
+  * [Pylint](https://www.pylint.org/) should not give any error or warning (few exceptions apply with external classes like `numpy`, see our `.pylintrc`).
+  * Python code follows [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/) (use `autopep8` whenever possible).
+
+C++
+---
+
+  * Compilation should not give any error or warning (`clang++ -Wall -Wextra -std=C++14`).
+  * Unreal C++ code (CarlaUE4 and Carla plugin) follow the [Unreal Engine's Coding Standard](https://docs.unrealengine.com/latest/INT/Programming/Development/CodingStandard/) with the exception of using spaces instead of tabs.
+  * CarlaServer uses [Google's style guide](https://google.github.io/styleguide/cppguide.html).

Docs/index.md

@@ -18,6 +18,7 @@ CARLA Documentation
 #### Contributing
 
   * [Contribution guidelines](CONTRIBUTING.md)
+  * [Coding standard](coding_standard.md)
   * [Code of conduct](CODE_OF_CONDUCT.md)
 
 #### Development

Docs/issue_template.md

@@ -3,7 +3,7 @@
 Thanks for contributing to CARLA!
 
 If you are asking a question please make sure your question was not asked before
-by searching among the existing issues. Also make sure you have read the our
+by searching among the existing issues. Also make sure you have read our
 documentation and FAQ at carla.readthedocs.io.
 
 -->

Docs/pull_request_template.md

@@ -5,14 +5,14 @@ view the contribution guidelines, then fill out the blanks below.
 
 Checklist:
 
-- [ ] Make sure you are making a pull request against the `dev` branch (not `master` please)
-- [ ] Your branch is up-to-date with `dev` branch and tested with latest changes
-- [ ] Extended the README / documentation, if necessary
-- [ ] Code compiles correctly
-- [ ] All tests passing
-  * [ ] `make check`
-  * [ ] `pylint --disable=R,C --rcfile=PythonClient/.pylintrc PythonClient/carla PythonClient/*.py`
-  * [ ] `cppcheck . -iBuild -i.pb.cc --enable=warning`
+  - [ ] Make sure you are making a pull request against the `dev` branch (not `master` please)
+  - [ ] Your branch is up-to-date with `dev` branch and tested with latest changes
+  - [ ] Extended the README / documentation, if necessary
+  - [ ] Code compiles correctly
+  - [ ] All tests passing
+    - [ ] `make check`
+    - [ ] `pylint --disable=R,C --rcfile=PythonClient/.pylintrc PythonClient/carla PythonClient/*.py`
+    - [ ] `cppcheck . -iBuild -i.pb.cc --enable=warning`
 
 -->
 

mkdocs.yml

@@ -16,6 +16,7 @@ pages:
   - 'How to add Automotive Materials': 'how_to_add_automotive_materials.md'
 - Contributing:
   - 'Contribution guidelines': 'CONTRIBUTING.md'
+  - 'Coding standard': 'coding_standard.md'
   - 'Code of conduct': 'CODE_OF_CONDUCT.md'
 - Development:
   - 'Map customization': 'map_customization.md'