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

Go Report Card: B grade #2

Open
flowchartsman opened this issue Jan 15, 2016 · 7 comments
Open

Go Report Card: B grade #2

flowchartsman opened this issue Jan 15, 2016 · 7 comments

Comments

@flowchartsman
Copy link

Now that you've open-sourced it, consider addressing the issues raised by Go Report Card here: http://goreportcard.com/report/EverythingMe/vertex

This often one of the first things people look at when evaluating a new project, though of course you can take the value of some of its recommendations with as few or many grains of salt as you like :)

On a side note, this looks like a nice, clean little REST framework. I look forward to seeing where it goes 👍

@dvirsky
Copy link
Member

dvirsky commented Jan 15, 2016

Thanks. Most of the vet errors are false hits, some are addressable indeed.

@flowchartsman
Copy link
Author

Depends on what you mean by "false positive", I guess. It looks like this is by design and that this error doesn't look like it's going anywhere any time soon: golang/go#12294. If passing vet is important, it would probably be a matter of changing the directives to have an 'f' on the end. Hope this helps!

@dvirsky
Copy link
Member

dvirsky commented Jan 15, 2016

The problem is not in the logging package IMHO, it's just naive heuristics in go vet. I've been happily ignoring them for years :)

@flowchartsman
Copy link
Author

¯_(ツ)_/¯ Hope the issue is at least a useful place to hang other fixes off, then :)

@dvirsky
Copy link
Member

dvirsky commented Jan 15, 2016

I was referring only to those specific vet errors. The linter errors were right though, oversights on my part since I mostly do run a linter on my code (but not as a build stage). Vertex was a for-work project, done, as work prjects usually go, in somewhat of a rush to finish.

Anyway, currently I've just opened it so it might get a second life, and not actively using it since the company I developed it for shut down (we did use it in production for a few months and it worked great). I hope it gets some adoption, as it worked great for us, and I'll actually get to fixing those. Right now it feels like tidying up a house that no one ever visits.

@flowchartsman
Copy link
Author

That's fair. To give it some more legs, you might also give a brief nod at the top to what distinguishes the project from other RESTFul frameworks (e.g. performance or a little more on what you mean by "friendly"). You don't have to go out of your way or anything, but I ran across this framework while looking for Golang REST frameworks that automatically generate Swagger, and it wasn't until I saw ToSwagger, that I realized you actually did this. IMHO, that's a big win, and a great feature and you should tout it.

@dvirsky
Copy link
Member

dvirsky commented Jan 15, 2016

You are damn right about the swagger thing, I've added a line to the README, but it deserves a better explanation, that every API has its own swagger URL.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants