Preparing report...

Report for github.com/release-lab/whatchanged

A    Great!    Found 11 issues across 15 files

Tweet

gofmt93%

Gofmt formats Go programs. We run gofmt -s on your code, where -s is for the "simplify" command


go_vet100%

go vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string.

No problems detected. Good job!


gocyclo60%

Gocyclo calculates cyclomatic complexities of functions in Go source code. The cyclomatic complexity of a function is calculated according to the following rules: 1 is the base complexity of a function +1 for each 'if', 'for', 'case', '&&' or '||' Go Report Card warns on functions with cyclomatic complexity > 15.


golint26%

Golint is a linter for Go source code.

    • whatchanged/option/options.go
    • Line 3: warning: exported type Format should have comment or be unexported (golint)
    • Line 4: warning: exported type Preset should have comment or be unexported (golint)
    • Line 7: warning: comment on exported const FormatMarkdown should be of the form "FormatMarkdown ..." (golint)
    • Line 9: warning: exported const FormatJSON should have comment (or a comment on this block) or be unexported (golint)
    • Line 10: warning: comment on exported const PresetDefault should be of the form "PresetDefault ..." (golint)
    • Line 16: warning: exported type Options should have comment or be unexported (golint)
    • whatchanged/3_transformer/transform.go
    • Line 16: warning: exported type Commit should have comment or be unexported (golint)
    • Line 28: warning: comment on exported type TemplateContext should be of the form "TemplateContext ..." (with optional leading article) (golint)
    • Line 56: warning: if block ends with a return statement, so drop this else and outdent its block (golint)
    • Line 61: warning: exported function Transform should have comment or be unexported (golint)
    • Line 76: warning: if block ends with a return statement, so drop this else and outdent its block (golint)
    • whatchanged/logger/logger.go
    • Line 15: warning: exported function New should have comment or be unexported (golint)
    • Line 19: warning: exported function Printf should have comment or be unexported (golint)
    • Line 23: warning: exported function Println should have comment or be unexported (golint)
    • Line 27: warning: exported function Print should have comment or be unexported (golint)
    • whatchanged/4_generator/generate.go
    • Line 20: warning: exported function Generate should have comment or be unexported (golint)
    • Line 55: warning: if block ends with a return statement, so drop this else and outdent its block (move short variable declaration to its own line if necessary) (golint)
    • Line 71: warning: if block ends with a return statement, so drop this else and outdent its block (move short variable declaration to its own line if necessary) (golint)
    • whatchanged/1_parser/parser.go
    • Line 14: warning: exported type Range should have comment or be unexported (golint)
    • Line 19: warning: exported type Scope should have comment or be unexported (golint)
    • Line 147: warning: if block ends with a return statement, so drop this else and outdent its block (move short variable declaration to its own line if necessary) (golint)
    • Line 206: warning: exported function Parse should have comment or be unexported (golint)
    • whatchanged/whatchanged.go
    • Line 31: warning: comment on exported function Generate should be of the form "Generate ..." (golint)
    • Line 150: warning: if block ends with a return statement, so drop this else and outdent its block (golint)
    • whatchanged/internal/commit/parser/parser.go
    • Line 9: warning: exported type Header should have comment or be unexported (golint)
    • Line 15: warning: exported type BreakingChange should have comment or be unexported (golint)
    • Line 20: warning: exported type Footer should have comment or be unexported (golint)
    • Line 25: warning: comment on exported type Message should be of the form "Message ..." (with optional leading article) (golint)
    • Line 68: warning: exported function Parser should have comment or be unexported (golint)
    • whatchanged/internal/client/git.go
    • Line 25: warning: exported type Tag should have comment or be unexported (golint)
    • Line 32: warning: exported function NewGitClient should have comment or be unexported (golint)
    • Line 88: warning: exported type GitClient should have comment or be unexported (golint)
    • Line 93: warning: comment on exported method GitClient.TagN should be of the form "TagN ..." (golint)
    • Line 114: warning: comment on exported method GitClient.PrevTag should be of the form "PrevTag ..." (golint)
    • Line 135: warning: comment on exported method GitClient.NextTag should be of the form "NextTag ..." (golint)
    • Line 155: warning: comment on exported method GitClient.TagName should be of the form "TagName ..." (golint)
    • Line 176: warning: comment on exported method GitClient.Tags should be of the form "Tags ..." (golint)
    • Line 216: warning: if block ends with a return statement, so drop this else and outdent its block (move short variable declaration to its own line if necessary) (golint)
    • Line 249: warning: comment on exported method GitClient.Head should be of the form "Head ..." (golint)
    • Line 254: warning: comment on exported method GitClient.Commit should be of the form "Commit ..." (golint)
    • Line 259: warning: comment on exported method GitClient.CommitByShort should be of the form "CommitByShort ..." (golint)
    • Line 282: warning: comment on exported method GitClient.GetFirstCommit should be of the form "GetFirstCommit ..." (golint)
    • Line 313: warning: comment on exported method GitClient.Logs should be of the form "Logs ..." (golint)
    • Line 353: warning: comment on exported method GitClient.PrevCommit should be of the form "PrevCommit ..." (golint)
    • Line 372: warning: comment on exported method GitClient.NextCommit should be of the form "NextCommit ..." (golint)
    • Line 398: warning: comment on exported method GitClient.GetTagRangesByTagName should be of the form "GetTagRangesByTagName ..." (golint)
    • Line 425: warning: comment on exported method GitClient.GetTagRangesByCommit should be of the form "GetTagRangesByCommit ..." (golint)
    • Line 448: warning: exported method GitClient.GetTagByCommit should have comment or be unexported (golint)
    • Line 464: warning: exported method GitClient.GetLastCommitOfTag should have comment or be unexported (golint)
    • Line 495: warning: if block ends with a return statement, so drop this else and outdent its block (golint)
    • Line 518: warning: exported method GitClient.GetPrevCommitOfTag should have comment or be unexported (golint)
    • Line 557: warning: exported method GitClient.GetRemote should have comment or be unexported (golint)
    • Line 566: warning: if block ends with a return statement, so drop this else and outdent its block (move short variable declaration to its own line if necessary) (golint)

license100%

Checks whether your project has a LICENSE file.

No problems detected. Good job!


ineffassign100%

IneffAssign detects ineffectual assignments in Go code.

No problems detected. Good job!


misspell93%

Misspell Finds commonly misspelled English words