Contributor Guide
Code Structure
See ARCHITECTURE.md for more information about how the code is structured, and what this repository does.
Dev Environment Tips
- Use go test <relative_path_to_package> to test a single package instead of everything, e.g.
go test ./certs - Don't do anything that relies on Docker
- Use
make formatto format code after making any changes - Use
make lintto catch other style and code errors
Testing Instructions
- Find the CI plan in the .github/workflows folder, it is roughly equivalent to
ensuring
make build,make lint, andmake testall pass. - Ensure
make build,make lint, andmake testall pass before finishing.