Keep increasing the quality of the whole project - Githubissues

notaryproject / notary

Notary is a project that allows anyone to have trust over arbitrary collections of data

Apache License 2.0

3.23k stars 510 forks source link

Keep increasing the quality of the whole project #1070

Open HuKeping opened 7 years ago

HuKeping commented 7 years ago

[ ] The code coverage of this project is about 80% at present, let's try more, test cases are always welcome.
[ ] Rework some package import style

The following is from @endophage

We've been nominally (and we should document it somewhere) stealing Python's PEP8 import formatting, which requires imports be broken into 3 blocks of:

import (
    // Std library imports
    "os" // etc...

    // 3rd party dependencies
    "github.com/sirupsen/logrus" // etc...

    // dependencies within the same project
    "github.com/docker/notary" // etc...
)

[x] Update the code comments which Golang suggested to, like comments all the export functions and variables.
[ ] Cleanup some old and unused code.
[ ] Reduce the duration of CI by removing some duplicate test code(we have some test code which has already covered by some other test code).

endophage commented 7 years ago

Checked off the 3rd bullet because golint runs as part of our CI and ensures we conform to that requirement. It's not failing at the moment which means all exported functions, types, and variables have comments conforming to Go coding standards.