Our commits are structured as follows: (commit type): (short description)
- The commit type is the type of commit you are making. See the table below for the correct commit type.
- The short description is a short description of the commit. It should be short and concise, but still descriptive enough to understand what the commit is for.
| Commit Type | Purpose of Commit | Example |
|---|---|---|
feat |
To add a feature or functionality | feat: added a new button for resetting heading |
fix |
To fix a bug or resolve issues and errors in code | fix: removed an infinite loop |
build |
To build the program (changed files) | build: updated the build system |
refactor |
To improve the structure of the code | refactor: organized the swerve module class |
perf |
Restructuring or organization that improves the organization of the code | perf: improved the acceleration of the swerve module |
docs |
To add or update documentation | docs: updated REV documentation |
chore |
Miscellaneous commits such as modifying READ.md or gitignore | chore: updated gitignore |