jeffreytse/grimoire

0

/ 100

Documentation86
Engineering89
Health100
Go13MIT1d ago
Grade a repo

Well engineered for its size. A portfolio piece worth showing off.

🧙 Democratizing best practices across 27 domains. Your AI knows everything — Grimoire makes it practice it.

Documentation

86

Contributing guide5pt30

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

89

CI/CD14pt72

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

Reproducibility6pt75

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

Tests18pt100

Test files detected (cmd/selfupdate_export_test.go).

Linting and formatting5pt100

Formatting enforced (.golangci.yml).

Issue and PR templates6pt100

Issue or PR templates present.

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)
  • 1
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 13
    Watchers

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files16 root entries
  • .github
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/lint.yml).
    Good: Issue or PR templates present.
  • assets
  • cmd
    Good: Test files detected (cmd/selfupdate_export_test.go).
  • internal
  • scripts
  • .gitignore
    Good: .gitignore present.
  • .golangci.yml
    Good: Formatting enforced (.golangci.yml).
  • AGENTS.md
  • CLAUDE.md
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • LICENSE
    Good: Licensed under MIT.
  • main.go
  • Makefile
  • 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.