goreportcard

:sunrise: Sunset Notice: Thank you for an incredible 10+ years

To the Go community,

After more than a decade of serving the ecosystem, the time has come to sunset Go Report Card. Following the loss of our primary infrastructure sponsor, maintaining the web app is no longer sustainable.

What happens next:

The Web App: The live site will remain active until July 1st, 2026, after which the servers will be shut down.

The Code: The repository will remain on GitHub but will be archived as read-only.

Thank you to everyone who submitted a PR, reported a bug, used the tool, or supported us financially over the last decade.

With gratitude,

The Go Report Card Team

Go Report Card

A web application that generates a report on the quality of an open source Go project. It uses several measures, including gofmt, go vet, go lint and gocyclo. To get a report on your own project, try goreportcard.com.

Sponsors

Support us over on Patreon!

• Cody Wood
• Pascal Wenger
• Jonas Kwiedor
• PhotoPrism
• Kia Farhang
• Patrick DeVivo (MergeStat)
• Alexis Geoffrey

Installation

git clone https://github.com/gojp/goreportcard.git
cd goreportcard
make install

Now run:

GRC_DATABASE_PATH=./db make start

and you should see

Running on :8000...

Navigate to localhost:8000 and you should see the Go Report Card front page.

Command Line Interface

There is also a CLI available for grading applications on your local machine.

Example usage:

git clone https://github.com/gojp/goreportcard.git
cd goreportcard
make install
go install ./cmd/goreportcard-cli
goreportcard-cli

Grade .......... A+  99.9%
Files ................ 362
Issues ................. 2
gofmt ............... 100%
go_vet ............... 99%
gocyclo .............. 99%
golint .............. 100%
ineffassign ......... 100%
license ............. 100%
misspell ............ 100%

Verbose output:

goreportcard-cli -v

Grade .......... A+  99.9%
Files ................ 362
Issues ................. 2
gofmt ............... 100%
go_vet ............... 99%
go_vet  vendor/github.com/prometheus/client_golang/prometheus/desc.go:25
        error: cannot find package "github.com/prometheus/client_model/go" in any of: (vet)

gocyclo .............. 99%
gocyclo download/download.go:22
        warning: cyclomatic complexity 17 of function download() is high (> 15) (gocyclo)

golint .............. 100%
ineffassign ......... 100%
license ............. 100%
misspell ............ 100%

Contributing

Go Report Card is an open source project run by volunteers, and contributions are welcome! Check out the Issues page to see if your idea has already been mentioned. Feel free to raise an issue or submit a pull request.

Academic Citation

If you use Go Report Card for academic purposes, please use the following citation:

@Misc{schaaf-smith-goreportcard,
    author = {Schaaf, Herman and Smith, Shawn},
    title  = {Go Report Card: A report card for your Go application},
    year   = {2015--},
    url    = {https://www.goreportcard.com/},
    note   = {[Online; accessed <today>]}
}

License

The code is licensed under the permissive Apache v2.0 license. Read this for a summary.