yangavin/.dotfiles

0

/ 100

Documentation63
Engineering70
Health63
Shell02mo ago
Grade a repo

Early stage. Tests, CI, and a strong README would raise this score quickly.

my dotfiles

Documentation

63

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.

README12pt50

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

A license file is present.

Engineering

70

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.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

Tests18pt80

Test files detected (zsh-autocomplete/Tests).

CI/CD14pt100

CI is configured (zsh-autocomplete/.github/workflows/lock.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

63

Dependency manifest6pt0

No dependency manifest detected at root.

→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

Activity5pt80

Actively maintained (pushed within 3 months).

Repository metadata5pt100

Repository has a description.

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
  • 0
    Watchers

Responsiveness

  • 3d 19h
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files9 root entries
  • home
    Good: .gitignore present.
  • manual-imports
  • minimal
  • zsh-autocomplete
    Good: A license file is present.
    Good: Test files detected (zsh-autocomplete/Tests).
    Good: CI is configured (zsh-autocomplete/.github/workflows/lock.yml).
    Good: Issue or PR templates present.
  • backup.sh
  • install.sh
  • macos.sh
  • README.md
    Good: README is present.
    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.
    Good: README documents how to run the project.
  • setup_minimal.sh