Contribution Guidelines
How to contribute to the project
Contributing code
If you have improvements to any projects of ROS Agriculture, send us your pull requests! For those just getting started, Github has a howto.
C++ coding style
Your C++ code should conform to Google C++ Style Guide.
Use clang-tidy
to check your C/C++ changes. To install clang-tidy
on ubuntu:16.04, do:
apt-get install -y clang-tidy
You can check a C/C++ file by doing:
clang-format <my_cc_file> --style=google > /tmp/my_cc_file.cc
diff <my_cc_file> /tmp/my_cc_file.cc
Python coding style
Your Python code should conform to Google Python Style Guide
Use pylint
to check your Python changes. To install pylint
and
retrieve TensorFlow’s custom style definition:
pip install pylint
wget -O /tmp/pylintrc https://raw.githubusercontent.com/tensorflow/tensorflow/master/tensorflow/tools/ci_build/pylintrc
To check a file with pylint
:
pylint --rcfile=/tmp/pylintrc myfile.py
Coding style for other languages
- Google Java Style Guide
- Google JavaScript Style Guide
- Google Shell Style Guide
- Google Objective-C Style Guide
Last modified 03.02.2019: Agritech Robotics (b859081)