Skip to content

Write page: Concepts > Coding conventions #22

Open

Description

@vmbrasseur
No description provided.

Activity

  1. vmbrasseur commented on Feb 12, 2014

    @vmbrasseur
    MemberAuthor

    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.

  2. vmbrasseur commented on Feb 24, 2014

    @vmbrasseur
    MemberAuthor

    Link this to the whitespace page.

  3. notbenh commented on Jul 30, 2014

    @notbenh

    [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] )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions