homebrew/brew

0

/ 100

Documentation85
Engineering80
Health100
Ruby48,560BSD-2-Clause5d ago
Grade a repo

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

🍺 The Package Manager for Everywhere

Documentation

85

Contributing guide5pt61

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under BSD-2-Clause.

Engineering

80

CI/CD14pt57

CI is configured (.github/workflows/check-issues.yml).

Tests18pt80

Test files detected (Library/Homebrew/head_software_spec.rb).

Linting and formatting5pt100

Ruby linting configured (.editorconfig).

Reproducibility6pt100

Lockfile present (Library/Homebrew/Gemfile.lock). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (Library/Homebrew/Gemfile).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files28 root entries
  • .claude
  • .codex
  • .cursor
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/check-issues.yml).
    Good: Dependabot covers 5 ecosystems (bundler, devcontainers, docker, github-actions, pip). Dependencies stay current.
    Good: Issue or PR templates present.
  • .licenses
  • .sublime
  • .vscode
  • bin
  • completions
  • docs
  • Library
    Good: Test files detected (Library/Homebrew/head_software_spec.rb).
    Good: Lockfile present (Library/Homebrew/Gemfile.lock). Installs are reproducible.
    Good: Dependency manifest found (Library/Homebrew/Gemfile).
  • manpages
  • package
  • .dockerignore
  • .editorconfig
    Good: Ruby linting configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .shellcheckrc
  • .vale.ini
  • AGENTS.md
  • CHANGELOG.md
  • CLAUDE.md
  • CODEOWNERS
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • LICENSE.txt
    Good: Licensed under BSD-2-Clause.
  • README.md
    Good: README is present.
    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.
    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.