search

Team2337 / offseasonDebugDashboard

Revamp of the 2012 Dashboard to include functions for debugging.
1 stars 0 forks source link

Naming Conventions #3

Open zpolygon95 opened 12 years ago

zpolygon95 commented 12 years ago

Not really a big issue, but I think that we should set up some sort of file naming conventions. My propositions are as follows:

-Comprehensive file names (nothing like poops.vi or party.lib etc.) -camel-case e.g. "drivetrainControl.vi", "getDashboardData.vi" etc.

I just want to be able to look through the project files and find what I need right away without having to rely on documentation to find out what a file is basically supposed to do.

~Zac

cbolinger commented 12 years ago

Also, since our GitHub is public we need to aware that anyone will be able to read our code or comments. Naming Conventions can also pertain to the Variables as well.

szechy commented 12 years ago

I agree with what Zac says. I love camelCase, personally. I find that non-comprehensive file names come from goofing around/being unable to immediately come up with a name. I remedied "party.vi" (renamed debugMain.vi) after coming up with the better name, for instance.

ZachOrr commented 12 years ago

Has anyone been working on a Wiki page with standards/quick start for programming? Putting down how you want files named should go in there.