Update coding standard

This commit is contained in:
nsubiron 2018-01-10 13:29:52 +01:00
parent e1847f2001
commit 84b20488d1
3 changed files with 36 additions and 14 deletions

View File

@ -15,7 +15,7 @@ Reporting bugs
--------------
Use our [issue section](issueslink) on GitHub. Please check before that the
issue was not already added.
issue is not already reported.
[issueslink]: https://github.com/carla-simulator/carla/issues
@ -31,10 +31,14 @@ your request as a new issue.
Code contributions
------------------
So you are considering making a code contribution, great! we love to have
contributions from the community.
Before starting hands-on on coding, please check out the
[projects page][projectslink] to see if we are already working on that. In case
of doubt or to discuss how to proceed, please contact one of us (or send an
email to carla.simulator@gmail.com).
[projects page][projectslink] to see if we are already working on that, it would
be a pity putting an effort into something just to discover that someone else
was already working on that. In case of doubt or to discuss how to proceed,
please contact one of us (or send an email to carla.simulator@gmail.com).
[projectslink]: https://github.com/carla-simulator/carla/projects/1
@ -42,22 +46,40 @@ email to carla.simulator@gmail.com).
Check out the ["CARLA Design"](carla_design.md) document to get an idea on the
different modules that compose CARLA, and chose the most appropriate one to hold
the new feature.
the new feature. We are aware the developers documentation is still scarce,
please ask us in case of doubt, and of course don't hesitate to improve the
current documentation if you feel confident enough.
#### Coding style
#### Coding standard
Please follow the current coding style when submitting new code.
###### General
* Use spaces, not tabs.
* Comments should not exceed 80 columns, code may exceed this limit a bit in rare
occasions if it results in clearer code.
* 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).
* 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.
###### 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).
#### Pull request
#### Pull-requests
Once you think your contribution is ready to be added to CARLA, please submit a
pull request and one of our team members will take a look at it.
pull-request to the `dev` branch.
Try to be as descriptive as possible when filling the pull-request description.
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.

View File

@ -1,4 +1,4 @@
CXX=g++
CXX=clang++
FLAGS=-Wall -Wextra -std=c++14 -fopenmp
LIBS=-lboost_system -lboost_filesystem -lboost_program_options -lpng -ljpeg -ltiff
HEADERS=*.h

View File

@ -4,9 +4,9 @@ Image Converter
Converts output images of depth and semantic segmentation to a prettier format.
Requires boost_system, boost_filesystem, boost_program_options, libpng, libtiff,
libjpeg and openmp.
libjpeg and libomp.
Compile with `g++ -std=c++14 -fopenmp`, for the default compilation just run
Compile with `clang++ -std=c++14 -fopenmp`, for the default compilation just run
make
make