Skip to content

Style Guide

Ben Brenkman edited this page Jan 31, 2019 · 7 revisions

Headers

All scripts should have headers. Each header must contain the following.

Description: Detailed and high level enough to understand the purpose of the script Date: Date must be in the DD MMM YYYY eg. 30 Jan 2019 Author: The name of the creator of the script, Git will keep track of your contributions through commits

Example:

'''
Description: ROS node that receives sensor information via a micro server
Last Modified: 30 Jan 2019
Author: John Doe
'''