Public:GitHub/Telemetry

	Out of Date
Content on this page may be out of date. Please verify with a group lead. If you are knowledgeable of the content, please update it or remove this label if it is here in error. Reason: Need more info about each repo and pages per repo

The strategy and telemetry group currently has 3 repositories: Telemetry, data-analysis, and Athena-v2.

Information about these repositories and their setups can be found in the README.md files in each repository.

clone the Telemetry repository using git clone --recursive <repo> and git clone <repo> for the other two.

The --recursive option looks for submodules in the repo and clones them into the correct directory. If this option was omitted during the initial clone, run the command git submodule update --init to find any un-cloned submodules and clone them. This only applies to the Telemetry repo that contains the CAN submodule with the CAN messages for the car.

Often changes will need to be made to the submodule GitHub/CAN. Please reference this page for more information.

About Repos

The Telemetry repo primarily holds the code for the telemetry application, the app that allows us to view and analyze car data in real time to diagnose issues and make informed decisions.

The Athena-v2 repo holds the coded for a car simulation and optimizer to determine optimal strategy decisions in a calculated and methodical way and is the focus of the strategy side of the group.

The data-analysis repo hold code used to analyze datalogger race data after the races to better understand the car and its performance. This is for the most part random experiments and programs to look at solutions to miscellaneous problems.

Workflow

The workflow of branches and commits should be similar to how the FW repo works. All work should be done in separate branches if multiple people are working on one feature, they should each have their own branches and merge them together when possible. Branches should not be merged into master until they are known to work without breaking the system.

To merge a branch in to master a pull request should be made and at least two reviewers should be requested. Once these reviewers have approved the pull request can be merged into master.

If changes need to be made quickly and shared and there is not time to follow the review process (for example during a race) a separate branch of master should be made for this. The changes should then be reviewed and cleaned when there is time and then the standard merging procedure should be followed to pull the changes into master.