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

Cleanup golint issues #18

Open
aesterline opened this issue Oct 3, 2017 · 4 comments
Open

Cleanup golint issues #18

aesterline opened this issue Oct 3, 2017 · 4 comments

Comments

@aesterline
Copy link
Contributor

This project started as a proof of concept. We have made more progress now and it would be good to clean up all of the golint errors.

To see the errors you can run make lint or see them in CodeClimate.

@dsocolobsky
Copy link

Almost every golint error is of the type exported method $METHOD should have comment or be unexported should we try and comment every exported method, set unnecessarily exported methods to unexported or just ignore those errors?

@aesterline
Copy link
Contributor Author

Hmm... I think we hide methods/types that don't need to be exported.

I think it would be nice to document the methods that should be exported. It might make it easier for others to contribute to the project if there was a little more documentation. I know this is a lot to ask considering you didn't write the code. It might be interesting to see if the concepts (types/functions) are understandable for you. If they don't it means their names/code should be improved.

I am happy to help in any way. Thanks for any help you can give.

@blockloop
Copy link

@dysoco if you don't plan on doing this I'll do it

@dsocolobsky
Copy link

@blockloop Sorry for the delay. Go ahead if you want to; I have midterms this week and can't compromise.

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

No branches or pull requests

3 participants