ornfelt/dots
Grade a repo

0

/ 100

GradeF

Some interest. A stronger README and CI would help.

My dotfiles for arch and debian linux

Documentation45
Engineering9
Health100
Lua26today

Documentation

45

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.

README12pt35

README is present.

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

License6pt100

A license file is present.

Engineering

9

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

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.

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

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 (installation/a0907bde0c/packages/debian/requirements.txt). Installs are reproducible.

Project health

100

Dependency manifest6pt100

Dependency manifest found (bin/my_scripts/2025/diff_dirs/diff_dirs.csproj).

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

Community

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

Responsiveness

  • -
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files22 root entries
  • .config
    Good: A license file is present.
    Good: .gitignore present.
  • .dwm
  • bin
    Good: Dependency manifest found (bin/my_scripts/2025/diff_dirs/diff_dirs.csproj).
  • diffs
  • installation
    Good: Lockfile present (installation/a0907bde0c/packages/debian/requirements.txt). Installs are reproducible.
  • Screenshots
  • tmux_session
  • vimwiki
  • .bash_profile
  • .bashrc
  • .gitconfig
  • .gitignore
  • .tmux.conf
  • .wezterm.lua
  • .xinitrc
  • .Xresources
  • .Xresources_cat
  • .zshrc
  • 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.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
    Good: README documents how to run the project.
  • setup.sh
  • sync_dots.sh
  • update_dots.sh