DEV_GUIDE.md

Developer guide

Description of useful tools and good practices to maintain code readability and reliability.

Tools

pre-commit

pre-commit configuration prepares plenty of tests helping for developing and contributing. Usage:

# install pre-commit
pip install pre-commit

# initialize pre-commit workspace
pre-commit install

# manually run pre-commit hooks
pre-commit run -a

# update revision
pre-commit autoupdate

After initialization pre-commit configuration will applied on every commit.

Run tests

# Run tests
colcon test

# Show results
colcon test-result --verbose

Note

Command colcon test does not build the code. Remember to build your code after changes.

Industrial CI

Download industrial package from github build it and run following command to run industrial_ci tests locally.

ros2 run industrial_ci rerun_ci src/ ROS_DISTRO=humble