skwp/dotfiles

0

/ 100

Documentation82
Engineering52
Health58
Ruby6,979BSD-2-Clause5mo ago
Grade a repo

Strong community interest, but tests, CI, or docs need work.

YADR - The best vim,git,zsh plugins and the cleanest vimrc you've ever seen

Documentation

82

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.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under BSD-2-Clause.

Engineering

52

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.

Reproducibility6pt10

No dependency lockfile found (−70 pts).

→ Commit Gemfile.lock so Bundler installs are repeatable.

CI/CD14pt40

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

Tests18pt80

Test files detected (bin/yadr/lib/git-style-binaries-0.1.11/test).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

58

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.

Activity5pt60

Last pushed 3-6 months ago (−40 pts). A push within 90 days earns 80 pts; within 30 days earns 100 pts.

→ A recent commit keeps the project looking alive to visitors and contributors.

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files27 root entries
  • .github
    Good: CI is configured (.github/workflows/stale.yml).
  • bin
    Good: Test files detected (bin/yadr/lib/git-style-binaries-0.1.11/test).
  • chrome
  • ctags
  • doc
  • fonts
  • git
  • irb
  • iTerm2
  • ruby
  • tmux
  • vim
  • vimify
  • zsh
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .yadr
  • CHANGELOG.md
  • docker-compose.yml
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • install.sh
  • LICENSE
    Good: Licensed under BSD-2-Clause.
  • Rakefile
  • 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.
  • vimrc