Skip to content
This repository has been archived by the owner on Jan 2, 2024. It is now read-only.

For Developers

Jump to bottom
Patrick Creighton edited this page Feb 4, 2022 · 4 revisions

Running tests

To run the tests, navigate to the catkin_ws directory and run catkin_make run_tests.

Linting

To ensure that the codebase stays clean, we will be using flake8 to enforce our style guide, which is mostly based off of pep8. To automate most of this process, you can use autopep8, which is a tool that automatically resolves most style issues. Example usage is shown below. Our team has agreed upon a 120 character line limit.

  • Installation 
    pip install flake8
pip install --upgrade autopep8
  • Usage 
    autopep8 --in-place --aggressive --max-line-length 120 --aggressive <path_to_file>
flake8 --statistics --max-line-length 120 <path_to_file>

Continuous Integration

To ensure that the code continues to work as we make changes, we have setup continuous integration with CircleCI. It pulls the Dockerhub image for ROS and OMPL, sets up the workspace, and runs the lint and tests. Click here to see how this is done.

Clone this wiki locally