indexeddbshim / IndexedDBShim

A polyfill for IndexedDB using WebSql
Other
968 stars 191 forks source link

Add LGTM code quality badges #328

Closed xcorail closed 6 years ago

xcorail commented 6 years ago

Hi there!

I thought you might be interested in adding these LGTM code quality badges to your project, to show how you care about code quality and encourage contributors to do the same. To get an idea of the analyses reflected by these grades, 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.

brettz9 commented 6 years ago

This seems like a quite useful site (I already applied a couple of the issues it flagged)... Are you just wary of adding more badges, @axemclion, or ... ?

@xcorail : Beyond a global config file, is there any in-code ignore flag to ignore any issues for a particular line only? I tend to prefer such flagging, as it also demonstrates to the reader of the code that the seemingly bad practice was intentional.

xcorail commented 6 years ago

Hi @brettz9

Happy you found it useful. You don't need to add the badge indeed to use LGTM, as daily report or as integrated in your PR. It's free for open source projects.

Yes, you can of course flag an entire line to suppress alerts, or a specific alert, just by inserting a //lgtm comment. See here

But you can also:

Cheers

P.S.

I already applied a couple of the issues it flagged

If so, you might consider registering to this competition: what you are already doing will contribute to a donation to WWF, and get a chance to win a trip to GitHub Universe in SF.

brettz9 commented 6 years ago

@xcorall : Very good to know about the inline suppressors, thanks, and I like the improvements I expect the competition will bring... The other info was good to know as well...