search

RITlug / teleirc

Go implementation of a Telegram <=> IRC bridge for use with any IRC channel and Telegram group
https://docs.teleirc.com/
GNU General Public License v3.0
138 stars 46 forks source link

Bring CodeClimate grade up to an A #64

Closed robbyoconnor closed 4 years ago

robbyoconnor commented 6 years ago

This is REALLY great for beginners looking to get their feet wet who knows Node.js well and has good code design instincts.

Currently we are at a D -- let's get it up!

Tjzabel commented 5 years ago

With commit 8931f1ae, we should slowly see an increase in the CC grade.

CodeClimate is being a little too strict, so we hope to loosen up some of its checks to improve this.

robbyoconnor commented 5 years ago

That's kind of the point. It's supposed to be strict -- it's running a linter.

On 10/30/18 11:22 AM, Tim Zabel wrote:

With commit 8931f1a https://github.com/RITlug/teleirc/commit/8931f1ae3f5a70acfe6e38588b569375aeab2d85, we should slowly see an increase in the CC grade.

CodeClimate is being a little too strict, so we hope to loosen up some of its checks to improve this.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/RITlug/teleirc/issues/64#issuecomment-434343855, or mute the thread https://github.com/notifications/unsubscribe-auth/AABaMIN7nOeO20PLDYQcsshCJIDTHs2zks5uqG7QgaJpZM4Vvks3.

Tjzabel commented 5 years ago

I get that it is supposed to be strict, but it seems to be overly strict. We're testing out a threshold before CC declares code to be duplicates, which is where a lot of the issues seem to arise.

If this doesn't work we can always revert to what it's been doing.

Tjzabel commented 5 years ago

Are we okay with CC's limit of 25 lines per method? Would we want to raise this to 30, or consider a re-factor of all methods above 25?

robbyoconnor commented 5 years ago

You can customize things -- Code Climate allows you to make calls on your own :) On 12/28/18 3:26 PM, Tim Zabel wrote:

Are we okay with CC's limit of 25 lines per method? Would we want to raise this to 30, or consider a re-factor of all methods above 25?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/RITlug/teleirc/issues/64#issuecomment-450421970, or mute the thread https://github.com/notifications/unsubscribe-auth/AABaMByIfWWAC8WJhnwGOUmt7QtmtI7oks5u9n6RgaJpZM4Vvks3.

jwflory commented 5 years ago

@Tjzabel 30 lines over 25 lines feels like a harmless change. When I write code, I'm more liberal with breaking things across multiple lines anyways for the benefit of readability.

robbyoconnor commented 5 years ago

There are valid reasons for deviating from coding standards...do so with good reason though. On 1/6/19 9:55 PM, Justin W. Flory wrote:

@Tjzabel https://github.com/Tjzabel 30 lines over 25 lines feels like a harmless change. When I write code, I'm more liberal with breaking things across multiple lines anyways for the benefit of readability.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/RITlug/teleirc/issues/64#issuecomment-451807108, or mute the thread https://github.com/notifications/unsubscribe-auth/AABaMJyw8kK12dtCttIoqUc5OUblxm26ks5vArcggaJpZM4Vvks3.

jwflory commented 4 years ago

Since we are in the middle of rewriting the codebase (#163) and already have some issues open to discuss code style and best practices (#73, #207), I'm going to close this issue as wontfix for the time being. Once we ship the v2.0.0 release and figure out what tools we can use for code health, we can open a new issue to discuss this later.

Closing. :clapper: