diff --git a/MaintenanceChecklist.md b/MaintenanceChecklist.md new file mode 100644 index 0000000..00c0f4a --- /dev/null +++ b/MaintenanceChecklist.md @@ -0,0 +1,21 @@ +# Maintenance checklist + +**Software leadership should get through the majority of updates each summer, before the offseason gets underway.** + +## Routine updates + +- [ ] Update WPILib version in example projects +- [ ] Update vendordeps in example projects +- [ ] Update usage of libraries like Choreo, PhotonVision, etc. in both explanations + example code +- [ ] Update WPILib usage (e.g. Commands syntax) in example projects + example snippets in walkthroughs +- [ ] Clean up branches from the adding names exercise +- [ ] Check for link rot (and please permalink when you can, especially GitHub repos) +- [ ] Replace links to code examples with newer/better examples (as needed) + +## 8033 specific + +- [ ] Update the [Electronics crash course](Docs/2_Architecture/2.2_ElectronicsCrashCourse.md). Generally, try not to remove anything, but note devices we've moved towards or away from. +- [ ] Update examples to reflect best practices for code organization and structure. This is sort of nebulous, but something like no AKit --> AKit, or no superstructure --> superstructure would warrant an update +- [ ] Update with libraries/other tools we've started/stopped using +- [ ] Any specific feedback you have received this year +- [ ] For 2027: Update with roboRIO --> SystemCore transition info