search

swagger-api / swagger-codegen

swagger-codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing your OpenAPI / Swagger definition.
http://swagger.io
Apache License 2.0
17.04k stars 6.03k forks source link

Add Codacy and TravisCI Badge in README.md #2002

Open wizardbyron opened 8 years ago

wizardbyron commented 8 years ago

I just use codacy analysis this repo, this is the code grade:

Codacy Badge

We can add this on to improve the code quality.

wing328 commented 8 years ago

@wizardbyron thanks. I'm not familiar with Codacy. Do you know what it uses to evaluate the code quality?

I used CodeClimate before which uses open source tools like PHP MD but I've to say I don't completely agree with everything produced in the code review report.

Anyhow I think it's a good idea to have another tool performing code review so that we can work on improving the code base.

wizardbyron commented 8 years ago

You can read more details in Dashboard and there are suggestions: https://www.codacy.com/app/ygu/swagger-codegen/issues?&filters=W3siaWQiOiJDYXRlZ29yeSIsInZhbHVlcyI6WyJFcnJvciBQcm9uZSJdfV0=

cog commented 8 years ago

Hi, guys!

I work at Codacy; spotted this conversation and figured I could try to help out.

@wing328: for Java, Codacy uses PMDJava and Checkstyle; we also run our own algorithms to check for code duplication.

You can enable/disable all the patterns in the settings of the project on Codacy; also, when an issue arises, expanding it will give you access (top right corner of the issue; must be logged in) to a few options, including "ignore issue" and "remove pattern".

I should add that aside from the code grade you'll also get reports per commit and per pull request, which is what will help you keep up the code quality while you can't afford to go back and look at all the issues that might be in the codebase. You can also enable auto-comments on PRs; here's an example of an auto-comment on an open source project by PayPal: https://github.com/paypal/squbs/pull/203#discussion_r64374677

Let me know if I can help with anything else.

wizardbyron commented 8 years ago

That's cool. Maybe you can add it to README.md. Let @wing328 make the decision.