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

Introduce Code Quality Tools to the Project #113

Closed
netme opened this issue Jan 19, 2017 · 8 comments
Closed

Introduce Code Quality Tools to the Project #113

netme opened this issue Jan 19, 2017 · 8 comments
Assignees
Labels
area: cli Issue with a Command Line Tool area: server Zally server issues question type: enhancement

Comments

@netme
Copy link
Contributor

netme commented Jan 19, 2017

In order to keep the codebase clean, we should introduce some code quality checking tools like PMD or CheckStyle for Java.

Since we also supporting Kotlin for the rule definitions, we also need to check tooling around this language.

@netme netme added area: cli Issue with a Command Line Tool type: enhancement area: server Zally server issues labels Jan 19, 2017
@maxim-tschumak
Copy link
Contributor

Error-prone is also a good option. (http://errorprone.info/)

@netme
Copy link
Contributor Author

netme commented Jan 20, 2017

@maxim-tschumak , yeah, looks like a good addition to other tools. We can use multiple of them.

@mkulak
Copy link
Contributor

mkulak commented Jan 20, 2017

We could look at: https://github.com/shyiko/ktlint

@netme
Copy link
Contributor Author

netme commented Jan 20, 2017

@mkulak thanks for the link. It looks good to me, we can give it a try.

@netme
Copy link
Contributor Author

netme commented Jan 22, 2017

⬆️ first part, more to come.

@fmueller
Copy link
Collaborator

Because Kotlin as a language does not have so good integration into SaaS code quality tools, it's ok to have it integrated into the build.

For Java we can do the same with Findbugs and PMD. But I also like Codacy (https://www.codacy.com) because they are integrating smoothly with our PR-flow. What do you think?

@netme
Copy link
Contributor Author

netme commented Jan 23, 2017

@fmueller thanks for your input.

Codacy looks nice, I really like how it's integrated with our pull requests, we can benefit from it.

From another hand, if we will go with PMD + FindBugs (and maybe + CheckStyle), we can use them locally during the development process, this will also protect us from pushing lower quality code.

We can also use errorprone instead of Findbugs because it operates on source instead of bytecode.

Thoughts?

@netme
Copy link
Contributor Author

netme commented Jan 30, 2017

Since this task is becoming quite big, opened 2 extra tickets #123 and #124 with leftovers. Closing this one.

@netme netme closed this as completed Jan 30, 2017
netme added a commit that referenced this issue Feb 2, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: cli Issue with a Command Line Tool area: server Zally server issues question type: enhancement
Projects
None yet
Development

No branches or pull requests

4 participants