hashicorp/vagrant

0

/ 100

Documentation77
Engineering87
Health94
Ruby27,158Other9d ago
Grade a repo

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Vagrant is a tool for building and distributing development environments.

Documentation

77

README12pt55

README is present.

Contributing guide5pt77

CONTRIBUTING guide found.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

87

Tests18pt80

Test files detected (.ci/spec).

CI/CD14pt85

CI is configured (.github/workflows/check-legacy-links-format.yml).

Reproducibility6pt92

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

Linting and formatting5pt100

Ruby linting configured (website/.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (Gemfile).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files29 root entries
  • .ci
    Good: Test files detected (.ci/spec).
  • .github
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
    Good: Code of conduct present.
    Good: CI is configured (.github/workflows/check-legacy-links-format.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • bin
  • builtin
  • contrib
  • ext
  • keys
  • lib
  • plugins
  • scripts
  • tasks
  • templates
  • test
  • website
    Good: Ruby linting configured (website/.editorconfig).
    Good: Lockfile present (website/package-lock.json). Installs are reproducible.
    Good: Environment pinned via website/.nvmrc.
    Issue: Build artifacts or local files may be committed (website/.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • .copywrite.hcl
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .vimrc
  • .yardopts
  • CHANGELOG.md
  • Gemfile
    Good: Dependency manifest found (Gemfile).
  • LICENSE
    Good: Licensed under Other.
  • Rakefile
  • 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.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    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.
  • RELEASE.md
  • vagrant-spec.config.example.rb
  • vagrant.gemspec
  • Vagrantfile
  • version.txt