cli icon indicating copy to clipboard operation
cli copied to clipboard
verified publisher icon civo

Repo standard/code quality analysis

Open SoulPancake opened this issue 1 year ago • 3 comments

I think this is a very early to comment on this but perhaps there's a lot of work to be done to make this repo better.

I was only going through the code, one of the very first things that comes as an issue is

  1. The incredibly large readme.md It's overwhelming to have all that info altogether at one place, instead it should be modularized to point to a bunch of separate docs describing the installation steps or other things, maybe links in some cases. It probably seems useful to have all the info at one place but it is not dev-friendly at all.

  2. Linters please? I don't mean to be a snob but without a linter eventually the debt of not maintaining code style can catch up, even though this is possibly only maintained by few people at this point, avoiding this as early as possible is a life-saver. image

  3. Straight up tests not working image image

Apart from having incredibly low coverage, the repo also has some not-working tests. Having properly tested code will definitely ensure low tech debt over-time.

I understand a lot of this might be tried/tested code and under maintenance but coming from working in very large repos with a significant number of contributors, hope all these points help out to be a large number of good first issues for the community.

I'm down to contribute to few of these and also help setting up automated checks for these to maintain quality, in this repo as well as others.

Cheers and good luck! Long live OpenSource.

SoulPancake avatar Jun 26 '24 19:06 SoulPancake

Hi @SoulPancake, thanks for bringing this up and sorry for the long delay! You brought up lots of valid points, we'll make sure to work on addressing the issues you've raised 😄

giornetta avatar May 06 '25 07:05 giornetta

Hi @SoulPancake and thanks for raising this. I agree with you 100%. We could evaluate splitting the three points of your issue in 3 more sub-issues:

  • Refactoring readme.md
  • Linter
  • Tests not working

I think all of them could be tagged as good first issue.

fulviodenza avatar May 06 '25 09:05 fulviodenza

@fulviodenza I believe the third issue has already been solved by #527.

Regarding the huge README file, I propose we should move that to a more structured Wiki section under this repository.

giornetta avatar May 06 '25 11:05 giornetta