homebrew/homebrew-core

0

/ 100

Documentation49
Engineering41
Health59
Ruby15,372BSD-2-Clause5d ago
Grade a repo

Huge star count, but README, tests, and CI need real investment.

🍻 Default formulae for the missing package manager for macOS (or Linux)

Documentation

49

README12pt18

README is present.

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt72

Contributing guide is detailed and thorough.

License6pt100

Licensed under BSD-2-Clause.

Engineering

41

Tests18pt0

No tests detected anywhere in the repository.

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

Reproducibility6pt22

No dependency lockfile found (−70 pts).

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

CI/CD14pt57

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

Linting and formatting5pt100

Linter or formatter configured (.rubocop.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

59

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.

Housekeeping3pt40

No .gitignore found (−60 pts).

→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files20 root entries
  • .github
    Good: CI is configured (.github/workflows/tests.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • Abstract
  • Aliases
  • audit_exceptions
  • cmd
  • Formula
  • Patches
  • style_exceptions
  • .rubocop.yml
    Good: Linter or formatter configured (.rubocop.yml).
  • .ruby-version
    Good: Environment pinned via .ruby-version.
  • AGENTS.md
  • CLAUDE.md
  • CODEOWNERS
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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.
    Good: Contributing guide includes code examples.
  • disabled_new_usr_local_relocation_formulae.json
  • formula_renames.json
  • LICENSE.txt
    Good: Licensed under BSD-2-Clause.
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    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.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • synced_versions_formulae.json
  • tap_migrations.json