harryzcy/mailbox
Grade a repo

0

/ 100

GradeB

Polished and well engineered. Punching above its star count.

Top 16% of 5,156 graded repos

Versatile email infrastructure on AWS serverless

Documentation85
Engineering86
Health100
Go255MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

5 to address
  1. 1
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  2. 2
    Reproducibility6pt

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

  3. 3
    Issue and PR templates6pt

    Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

  4. 4
    Contributing guide5pt

    Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

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.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

85

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

86

Issue and PR templates6pt0

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.

Reproducibility6pt85

Lockfile present (go.sum). Installs are reproducible.

Tests18pt100

Test files detected (functions/emailRestore/main_test.go).

CI/CD14pt100

CI is configured (.github/workflows/build.yml).

Linting and formatting5pt100

Formatting enforced (gofmt (built into Go toolchain)).

Project health

100

Dependency manifest6pt100

Dependency manifest found (go.mod).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 16
    Forks
  • 23
    Releaseslatest 3y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 255
    Watchers

Responsiveness

  • 3d 1h
    Median issue response
  • <1h
    Median PR merge time
  • 3
    Open issues
Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
  • .vscode
  • api
  • doc
  • functions
    Good: Test files detected (functions/emailRestore/main_test.go).
  • integration
  • internal
  • script
  • .gitignore
    Good: .gitignore present.
  • .terraform.lock.hcl
  • .tool-versions
    Good: Environment pinned via .tool-versions.
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • LICENSE
    Good: Licensed under MIT.
  • main.tf
  • Makefile
  • outputs.tf
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • SECURITY.md
    Good: Security policy present.
  • serverless.yml.example
  • terraform.tf
  • variables.tf
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/harryzcy/mailbox)](https://www.repo-grade.com/report/harryzcy/mailbox)

More graded Go repos