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

Define code formatting rules and setup a formatter or the maven checkstyle plugin #147

Closed
krichter722 opened this issue Mar 26, 2015 · 6 comments
Assignees

Comments

@krichter722
Copy link
Contributor

Currently there's a wild mixture of tabs and spaces (4 or 8) being used for indentation (some even mixed in the same file). I'd suggest 4 spaces indentation (no tabs due to incompatibility with mailing lists) for all files (java, XML, etc.) and use checkstyle rather than a formatter. Document everything is HACKING or CONTRIBUTING. I'd be willing to do it, just assign me.

@PhantomYdn
Copy link
Member

You are welcome to do that!
If you need code change: PR. If you want to change documentation: my idea was to use github wiki for that. There is already development documentation. Feel free to contribute in Wiki as well!

@krichter722
Copy link
Contributor Author

Btw, I'll licence all files which are missing a header (I didn't find one single after superficial search) as described in LICENSE with you name. What copyright year/years should I take (should be the one LICENSE was added to the public repository, right?)?

@krichter722
Copy link
Contributor Author

I think you need to used different keywords in commits. This is closed, right?

@PhantomYdn
Copy link
Member

I guess we can close this. But sometime before release I will reformat spacing.

@krichter722
Copy link
Contributor Author

The check_style.xml you created is fine. Maybe remove the spaces and enforce indentation at some point.

@PhantomYdn
Copy link
Member

Yea... Also will enforce JavaDocs once it will be ready.

@PhantomYdn PhantomYdn self-assigned this Apr 9, 2015
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

2 participants