bew/dotfiles
Grade a repo

0

/ 100

GradeF

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

Higher than 36% of 5,156 graded repos

All my dotfiles in one place!

Documentation28
Engineering48
Health100
Lua571mo ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to C (76).

See your top fixes
Now
F
51
Potential
C
76

Top fixes

Highest-impact changes first, ranked by point weight

15 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    CI/CD14pt

    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.

  3. 3
    README12pt

    Expand with a description, install steps, usage, and examples.

  4. 4
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

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

28

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

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.

README12pt40

README is present.

Install and run instructions9pt45

README documents how to install the project.

Engineering

48

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.

Reproducibility6pt70

Lockfile present (opencode/package-lock.json). Installs are reproducible.

Tests18pt80

Test files detected (nvim-myplugins/smart-bol.nvim/tests).

Linting and formatting5pt100

Linter or formatter configured (.windows/autohotkey-scripts/.editorconfig).

Project health

100

Dependency manifest6pt100

Dependency manifest found (gui/__unused__herbstluftwm/scripts/setup.cfg).

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

Community

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

Responsiveness

  • 284d 18h
    Median issue response
  • -
    Median PR merge time
  • 71
    Open issues
Repository files28 root entries
  • _WIP_SPECS
  • .windows
    Good: Linter or formatter configured (.windows/autohotkey-scripts/.editorconfig).
  • assets
  • bash_minimal
  • bin
  • gdb
  • gh
  • git
  • gui
    Good: Dependency manifest found (gui/__unused__herbstluftwm/scripts/setup.cfg).
  • ipy-startup
  • less
  • nix
  • nushell
  • nvim
  • nvim-myplugins
    Good: Test files detected (nvim-myplugins/smart-bol.nvim/tests).
  • opencode
    Good: Lockfile present (opencode/package-lock.json). Installs are reproducible.
  • powershell
  • shell
  • tmux
  • zsh
  • .gitignore
    Good: .gitignore present.
  • flake.lock
  • flake.nix
  • install_bruteforce.bash
  • justfile
  • psqlrc
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Good: README is well structured with multiple sections.
    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.
    Good: README has code examples.
    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.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • try-term-features.sh
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/bew/dotfiles)](https://www.repo-grade.com/report/bew/dotfiles)

More graded Lua repos