0
/ 100
Good shape overall. A few tweaks would push it into the top tier.
Top fixes
Highest-impact changes first, ranked by point weight
- 1README12pt
Add more sections (Overview, Install, Usage, Contributing) using ## headings.
- 2Install and run instructions9pt
Add a section showing how to install dependencies.
- 3Install and run instructions9pt
Add a section showing how to start or use the project.
- 4Install and run instructions9pt
Add a .env.example listing all required environment variables so contributors know what to set up.
Working through the fixes? Let every push regrade itself.
The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
54
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).
→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.
README is present.
Licensed under MIT.
Engineering
87
No issue or PR templates found (−100 pts).
→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.
Lockfile present (go.sum). Installs are reproducible.
Test files detected (secure_test.go).
CI is configured (.github/workflows/go.yml).
Formatting enforced (.golangci.yml).
Project health
84
No repository description set on GitHub (−60 pts).
→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.
Dependency manifest found (go.mod).
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 10Forks
- 5Releaseslatest 4mo ago
Community
- -Community health
- -authors own >50% of commits
- 138Watchers
Responsiveness
- 21d 23hMedian issue response
- 6hMedian PR merge time
- 3Open issues
Repository files12 root entries
- .githubGood: CI is configured (.github/workflows/go.yml).Good: Dependabot covers 2 ecosystems (github-actions, gomod). Dependencies stay current.
- example
- .gitignoreGood: .gitignore present.
- .golangci.ymlGood: Formatting enforced (.golangci.yml).
- .goreleaser.yaml
- go.modGood: Dependency manifest found (go.mod).
- go.sumGood: Lockfile present (go.sum). Installs are reproducible.
- LICENSEGood: Licensed under MIT.
- policy.go
- README.mdGood: README is present.Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.Good: README includes screenshots or visuals. Great for first impressions.Good: README has code examples.Good: README links to a live demo or deployed app.Good: README includes status badges.Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
- secure_test.goGood: Test files detected (secure_test.go).
- secure.go
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/gin-contrib/secure)