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

chore: address code quality #16

Open
pires opened this issue Dec 17, 2020 · 0 comments
Open

chore: address code quality #16

pires opened this issue Dec 17, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@pires
Copy link
Member

pires commented Dec 17, 2020

It's always a good idea - or so I believe - to adopt some best-practices early on, before a project moves past the prototype phase. While growing functionality is always great, there's added value in ensuring the code is properly documented.

Now, linting code at this point will make at least one of us go through it and learn. And, following #15, automatic linting should be run by CI so every contributor comments their code appropriately. That said, don't forget to set --set_error_status when calling golint in the Github worklow.

@pires pires added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant