Skip to content

This project needs some code style guidelines #19

@Brinsky

Description

@Brinsky

On several occasions I have found myself debating over whether or not this issue is worth opening, but I think it really does matter. Here are the reasons I find it so important:

  • Consistent formatting gives an open source project a degree of professionalism
  • Making formatting choices on the fly and knowing they probably aren't consistent with your previous choices is frustrating
  • Garbage in the source code is wasteful and annoying (extra blank lines, trailing whitespace)
  • Well-chosen formatting guidelines can help make code more readable
  • Seeing inconsistent formatting everywhere is frustrating in its own right (at least for me)

On the bright side, many auto-formatting tools exist to help correct the existing codebase, including some tools built into Eclipse. Some examples of Java formatting guidelines are provided by Google and Apache.

I realize that this issue never feels like top priority, but it at least deserves an open issue until the problem is corrected.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions