Go Modules

[BlakeFreer]

@Jinwoo-H @AndrewI26

Want to move the hil repo modules into racecar. What should we improve as we do this? How should we structure our modules for functionality, documentation, examples, and tests?

We will use this discussion to go over ideas. Might want some insight from @TylerStAmour and @samparent97 since they did a lot of the work last year.

For now, let's start moving the standalone modules from the HIL repo into a racecar/packages folder. We can always change this folder later so don't worry about that. I created a dev/go-modules branch for this effort, but make an issue for any specific task, like "Add Flow module" or "Add docs to Flow". As usual, create a branch for your issue, but on PR, set the base to dev/go-modules.

These might help

https://github.com/golang-standards/project-layout

https://go.dev/doc/modules/layout

https://go.dev/doc/modules/managing-source

[BlakeFreer]

GitHub support packages which can be versioned and distributed from within the repo

https://docs.github.com/en/packages/learn-github-packages/introduction-to-github-packages

[BlakeFreer]

I spoke with @samparent97 today and decided that we will not move all of HIL in to racecar/. The standalone modules will stay in hil/ and only those specific to our test setup will move the racecar. In some sense, we will think of the "hil modules" like flow and canlink as external dependencies that racecar uses to test itself. We should abstract as much of the common hil behaviour to make it really easy to set up a specific test suite from for racecar/.

This decision is also influenced by the fact that other teams, like Mac Mars Rover and UBC FSAE, have expressed interest in using our HIL, so let's try to make it as standalone as possible, with good documentation and examples, so they can get it working easily.