Description
We want to enable golint on our codebase for several reasons:
- We want to improve code quality
- We need objective filters on quality to help us discriminate bad pull requests
How to
Following is the list of all github.com/docker/docker subpackages. For each we need to:
- Submit a PR cleaning all existing
golint warnings. One thing to keep in mind is that golint will require that every exported symbol has a comment: favor making symbols private where possible before documenting.
- Enable
golint on this package as part of the Jenkins CI jobs to make sure we don't diverge (something that individual contributors can do, but @jfrazelle who owns the testing infrastructure will help with that).
We also need to make it easy for contributors to easily give golint a local run before submitting the PR. We should probably have that script only cover a hardcoded list of packages that we can augment over time.
Packages:
Final task:
Description
We want to enable
golinton our codebase for several reasons:How to
Following is the list of all
github.com/docker/dockersubpackages. For each we need to:golintwarnings. One thing to keep in mind is thatgolintwill require that every exported symbol has a comment: favor making symbols private where possible before documenting.golinton this package as part of the Jenkins CI jobs to make sure we don't diverge (something that individual contributors can do, but @jfrazelle who owns the testing infrastructure will help with that).We also need to make it easy for contributors to easily give
golinta local run before submitting the PR. We should probably have that script only cover a hardcoded list of packages that we can augment over time.Packages:
Final task:
golintas part of CI on all non-vendored subpackage (I have the patch ready to fire)