Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up the codebase formatting and comments #9

Open
jamestmartin opened this issue Feb 8, 2018 · 1 comment
Open

Clean up the codebase formatting and comments #9

jamestmartin opened this issue Feb 8, 2018 · 1 comment

Comments

@jamestmartin
Copy link

These are a bunch of miscellaneous changes.

  • Since we are going to start using spaces instead of tabs, we should convert the whole codebase to spaces
  • We should remove the worthless "Created by Hazen Robotics" autogenerated comments
  • We should go back through and add Javadoc wherever it doesn't already exist, which happens to be most of the codebase, now that we have the time to do it
  • We should look for general formatting issues and make sure all of our code is formatted consistency, perhaps defining a prettyprint configuration and running it on all of TeamCode
  • We should make sure we use consistent naming conventions and that all of the variable names make sense

Note that these changes are very likely to break merges despite having no real content, so be sure to work with the rest of the team to minimize conflicts, perhaps breaking up the work to only make changes that nobody else is working on.

@jamestmartin jamestmartin added this to Planned in Off season via automation Feb 8, 2018
@mschwamborn
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Off season
  
Planned
Development

No branches or pull requests

2 participants