g0t4/dotfiles
Grade a repo

0

/ 100

GradeF

Getting some notice. Tests and CI would be the fastest wins.

dotfiles, nvim, hammerspoon, alfred - the only repo I need to clone to a new machine!

Documentation22
Engineering49
Health100
Lua16Othertoday

Documentation

22

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

Contributing guide5pt0

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.

README12pt8

README is present.

License6pt100

Licensed under Other.

Engineering

49

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

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.

Tests18pt80

Test files detected (.config/hammerspoon/config/macros/screenpal/co/tests).

Reproducibility6pt80

Lockfile present (uv.lock). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

100

Dependency manifest6pt100

Dependency manifest found (pyproject.toml).

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

Community

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

Responsiveness

  • 26d 2h
    Median issue response
  • <1h
    Median PR merge time
  • 1
    Open issues
Repository files31 root entries
  • .agents
  • .config
    Good: Licensed under Other.
    Good: Test files detected (.config/hammerspoon/config/macros/screenpal/co/tests).
    Good: Environment pinned via .config/nvim/queries/dockerfile.
    Good: .gitignore present.
  • .ctags.d
  • .grc
  • .ipython
  • .vscode
  • bash
  • fish
  • git
  • install
  • iterm2
  • macos
  • misc
  • nix
  • pwsh
  • zsh
  • .clang-format
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
  • .luarc.json
  • .python-version
  • .rag.yaml
  • .tsqueryrc.json
  • flsproject.fnl
  • LICENSE.txt
  • Makefile
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • pyrightconfig.json
  • README.md
    Good: README is present.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    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.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    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.
  • TODOnvimREMINDER.md
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.