search

Team2337 / 2014-Aerial-Assist

This is the Team 2337 "EngiNERDS" code for the FRC 2014 game Aerial Assist.
3 stars 0 forks source link

Code Cleanliness #3

Open Morgeno opened 10 years ago

Morgeno commented 10 years ago

Please keep your code clean.

If you are unsure what makes it "clean" then you can follow this guide: https://github.com/Team2337/2013-Ultimate-Ascent/wiki/Rules-of-Code-Cleanliness

Remember, take notes, and do your best to keep it aesthetically pleasing.

If you don't keep your code clean, this adds unnecessary pressure on other Brogrammers when they need to add features later in the season, and you aren't there to guide them through it.

zpolygon95 commented 10 years ago

Morgan, I am quite impressed with the standard you are trying to set this year, and hope to see the 2014 brogrammers maintaining that standard.

I have one suggestion that may help with your documentation: Use the wiki! This is one resource that I wish we had taken advantage of since we started using github. I recommend using this repositorys wiki page to document every vi in the project, complete with theroies of operation, known bugs, etc. I'll leave the implementation up to you.

Keep up the good work!

~Zac

ZachOrr commented 10 years ago

I'm not a part of the team, but use the wiki

~Less popular Zach

Morgeno commented 10 years ago

That's a good idea, I'll work on implementing it in the near future. Right now I'm trying to get labview to work because something broke. I don't know what, but something broke.

Thanks! -Morgan