mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-20 00:51:42 +00:00
1c3882ec72
This commit is intended to be used a place to start work on getting the styleguides which we would like to use for WPILib up to date in some useful format. This particular commit need not be merged immediately and people who wish to contribute to/have suggestions for the style guide can either comment on this or make commits based on this with their suggestions. The changes in this commit itself are relatively minimal, just adding reminders that the style guides are works in progress. The main things which we need to do to get the style guides useful are: -Making formatting rules clear/easy to follow. For instance, I do not believe that the original guides linked straight to the eclipse format configuration files, even though they are quite useful. -Adding in some WPILib specific stuff and information about how best to work on the code in our environment. -Removing any guidelines which we don't want or don't need. -Making the style guide readable/accessable enough that we can actually expect people to use/read it. -Determining how/to what degree we want to enforce the strictures in the style guide. -Determining how to handle our pre-existing code to either update it outright or to grandfather it in. -Any other things to do which I may have forgotten while writing this commit message. Change-Id: Ia6ea131e7d81d8c77a0487c8da17c0b264590e06
