aquaproj/aqua-registry
Grade a repo

0

/ 100

GradeF

Popular for its size, but the engineering basics lag behind the interest.

Higher than 38% of 5,156 graded repos

aqua's Standard Registry

Documentation64
Engineering40
Health68
YAML345MIT4mo ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to B (81).

See your top fixes
Now
F
53
Potential
B
81

Top fixes

Highest-impact changes first, ranked by point weight

20 to address
  1. 1
    Tests18pt

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

  2. 2
    CI/CD14pt

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  3. 3
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  4. 4
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

64

Install and run instructions9pt45

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

Contributing guide5pt47

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

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

README12pt68

README is present.

License6pt100

Licensed under MIT.

Engineering

40

Tests18pt0

No tests detected anywhere in the repository.

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

Reproducibility6pt10

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/check-commit-signing.yaml).

Linting and formatting5pt100

Linter or formatter configured (.prettierrc.json).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

68

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.

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 351
    Forks
  • 960
    Releaseslatest 5y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 345
    Watchers

Responsiveness

  • 11h
    Median issue response
  • <1h
    Median PR merge time
  • 323
    Open issues
Repository files27 root entries
  • .agents
  • .claude
  • .github
    Good: CI is configured (.github/workflows/check-commit-signing.yaml).
    Good: Issue or PR templates present.
  • aqua
  • docker
    Good: Environment pinned via docker/Dockerfile.
  • docs
  • pkgs
  • policy
  • scripts
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .prettierignore
  • .prettierrc.json
    Good: Linter or formatter configured (.prettierrc.json).
  • AGENTS.md
  • aqua-all.yaml
  • aqua-policy.yaml
  • aqua-registry-updater.yaml
  • aqua.yaml
  • CLAUDE.md
  • cmdx.yaml
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +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).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • GEMINI.md
  • LICENSE
    Good: Licensed under MIT.
  • lintnet.jsonnet
  • 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.
    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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.
  • registry.yaml
  • renovate.json5
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/aquaproj/aqua-registry)](https://www.repo-grade.com/report/aquaproj/aqua-registry)

More graded YAML repos