Home

Welcome to the urc-intelligent-systems-2023 wiki!

Here you can learn about the workflow that we use for our repo.

Branch Setup

Permanent branches:

• main
• dev

These branches are permanent. Main is our stable branch and works when running the entire system on the rover. The dev branch is for features that haven't been tested out on the rover but are known to work by themselves.

When contributing a feature, use descriptive names and owners. For example, john/test-asynchronous-sensors is a great, descriptive branch name. Feature branches should be concise! It should last at most a couple of weeks, and as soon as it is merged into dev, it should be deleted. Before merging into dev, make sure that your code satisfies the following:

• documentation - all methods/functions should be documented with docstrings describing their purpose and any arguments
• working - your code works as expected and passes any relevant tests

Code Style / Standards

• Avoid global variables as much as possible since these can lead to unfortunate headaches later down the line
• You can start with functions, but the finalized code should be self-contained classes.