search

stepzero / stepzero.github.io

StepZero website
Other
0 stars 2 forks source link

Write page: Concepts > Coding conventions #22

Open vmbrasseur opened 10 years ago

vmbrasseur commented 10 years ago

This is a religious issue for a lot of developers and projects. Cuddle your braces the wrong way and you can get raked over the coals. It happens, sorry.

Whether you're writing code, documentation, or even just a bug report, most projects have some sort of preferred format for same. They may not have it documented, but they have a preference.

When you start to contribute, check for some sort of "Coding standards" documentation in the project. If it doesn't exist, ask (link to asking questions) someone about it. Don't assume that just because it's not documented no one cares about it. They do. They really, really do.

So just ask. You'll be glad you did.

vmbrasseur commented 10 years ago

Link this to the whitespace page.

notbenh commented 9 years ago

[clarification] is the intent here to explain that there ~are~ coding conventions rather than say that you ~should~ cuddle your braces, ect?

[analogy] conceptually this is nothing different than the already complicated English style guides ala http://www.chicagomanualofstyle.org/home.html so it might be worth using this as an example or use an Oxford Comma as an example of how this gets to be a religious debate that generally is an argument about details rather than larger concepts as cuddled and non-cuddled elses will compile the same (assuming that it is not a syntax error in [insert your language here] )