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

Add LGTM code quality badges #2290

Closed
wants to merge 1 commit into from

Conversation

Projects
None yet
2 participants
@xcorail
Copy link

commented Sep 4, 2018

Hi there!

I thought you might be interested in adding these code quality badges to your project. They will indicate a very high code quality to potential users and contributors.
You can also check the alerts discovered by LGTM.

N.B.: I am on the team behind LGTM.com, I'd appreciate your feedback on this initiative, whether you're interested or not, if you find time to drop me a line. Thanks.

@jbertram

This comment has been minimized.

Copy link
Contributor

commented Sep 4, 2018

I couldn't find a description of what the grades on the badges actually mean. Do you have any idea about that?

@xcorail

This comment has been minimized.

Copy link
Author

commented Sep 5, 2018

Hi @jbertram

The code quality grade, or grade, is an estimation of the relative quality of a project when compared to similar reference projects. It is a letter between A+ and E that puts the score in perspective.

You can read more in our documentation, and I recommend also this long but very interesting blog post

These grades will be useful for your potential users, as they will tend to select high quality projects rather than poor quality ones. But as contributor or owner, I guess you'll be more interested in viewing the alerts. For this use, we recommend Pull Request integration, that you can activate in one click. LGTM will report any new problem (or fix) directly within the pull request.

@jbertram

This comment has been minimized.

Copy link
Contributor

commented Sep 6, 2018

I'm dubious about users selecting a project based on the code quality rating from lgtm.com, but I am interested in the pull-request integration as I can think of at least one mistake it would have saved me from a few months back.

@xcorail

This comment has been minimized.

Copy link
Author

commented Sep 6, 2018

I'm dubious about users selecting a project based on the code quality rating from lgtm.com

Thanks for this feedback. This is something we are trying to assess atm. If you have read the blog post, you might have seen at the end a surprisingly good correlation between our grades and the project popularity. So we're trying to find out a bit more from actual usage.

I am interested in the pull-request integration as I can think of at least one mistake it would have saved me from a few months back.

Happy to hear that. Feel free to activate PR integration here and let me know.

@jbertram

This comment has been minimized.

Copy link
Contributor

commented Dec 18, 2018

I don't think there's currently any plan to merge this. Could you close this PR, @xcorail?

@xcorail

This comment has been minimized.

Copy link
Author

commented Dec 18, 2018

Hello @jbertram
Done

@xcorail xcorail closed this Dec 18, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.