Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document project coding standards #69

Open
sebbrudzinski opened this issue Feb 25, 2016 · 0 comments
Open

Document project coding standards #69

sebbrudzinski opened this issue Feb 25, 2016 · 0 comments

Comments

@sebbrudzinski
Copy link
Owner

Lately, we have integrated the checkstyle plugin with the Ant build. The checkstyle plugin is responsible for verifying and enforcing coding standards in the project. The checkstyle rules are heavily based on the Java coding conventions by Oracle. It's a good time to prepare a wiki page, that lists at least some of the most important rules, that are often broken in the new pull requests (braces placement, unusued imports, modifiers order, etc.) All the rules we use are under the project directory, in the checkstyle.xml file (it only contains name, but it's easy to find the meaning on the Checkstyle website)

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

No branches or pull requests

1 participant