You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,13 +46,12 @@ make help
46
46
47
47
48
48
## Contributing
49
-
This repo follows the CU Robotics code standard:
50
-
- Branches are categorized into three groups: `production`, `feature`, and `patch`.
51
-
- Only authorized members can merge to `production` branches, such as `main`. All merges must go through a review and merge request. Direct pushes to `production` branches are strictly forbidden.
52
-
-`feature` branches are named `feature-[featurename]` and contain major new features that require unit and integration testing.
53
-
-`patch` branches are named `patch-[patchname]` and contain bugfixes and/or minor adjustments. Unit and integration testing is a soft requirement.
54
-
- All software is required to pass formatting and build tests before being merged into a `production` branch.
55
-
- Other branch-based style questions are answered in the [style guide](docs/README.md).
49
+
`main` is the production branch, which is required to be in an always working state.
50
+
- Only authorized members can merge to `main`. All merges must go through a review and pull request. Direct pushes to `main` branches are strictly forbidden.
51
+
- To contribute, create a new branch with a descriptive name for your change. Create a pull request when done, and provide a short explanation for the change.
52
+
- Pull Requests (PRs) should be as small as possible, dedicated to a specific purpose. A feature does not have to be complete for a pull request to be made, but what *is* added must be functional and tested. Multiple small PRs is better than one large PR.
53
+
- Smaller PRs are significantly faster to review and test, so expect a slower review process for massive PRs.
54
+
- All software is required to pass [documentation](docs/README.md), build, and unit tests, and have all warnings resolved, before being merged into the `main` branch.
56
55
57
56
## Licensing
58
57
This repository uses the MIT License, which covers the code and tools written for our robot firmware. See separate copyright/licensing information for the external libraries used in the repo (in the libaries/ and teensy4/ directories).
0 commit comments