sbdchd/squawk
Grade a repo

0

/ 100

GradeB

A well-known project done right. Strong docs and solid engineering throughout.

Top 20% of 5,156 graded repos

🐘 Linter for Postgres migrations & SQL

Documentation83
Engineering85
Health95
PLpgSQL1,116Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

12 to address
  1. 1
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  2. 2
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  3. 3
    Reproducibility6pt

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

  4. 4
    Issue and PR templates6pt

    Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

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

83

Contributing guide5pt60

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.

README12pt80

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Apache-2.0.

Engineering

85

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.

Reproducibility6pt80

Lockfile present (Cargo.lock). Installs are reproducible.

Tests18pt100

Test files detected (crates/squawk/tests).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (.eslintrc.js).

Project health

95

Dependency manifest6pt83

Dependency manifest found (Cargo.toml).

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)
  • 65
    Forks
  • 128
    Releaseslatest 5y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 1,116
    Watchers

Responsiveness

  • 9h
    Median issue response
  • <1h
    Median PR merge time
  • 40
    Open issues
Repository files37 root entries
  • .cargo
  • .github
    Good: CI is configured (.github/workflows/python.yml).
  • .vscode
  • crates
    Good: Test files detected (crates/squawk/tests).
  • docs
  • js
  • npm
  • playground
  • postgres
    Good: Licensed under Apache-2.0.
  • s
  • squawk-vscode
  • .eslintignore
  • .eslintrc.js
    Good: Linter or formatter configured (.eslintrc.js).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .kodiak.toml
  • .npmignore
  • .oxfmtrc.json
  • .pre-commit-hooks.yaml
  • .python-version
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
  • clippy.toml
  • 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).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • example.sql
  • flake.lock
  • flake.nix
  • LICENSE-APACHE
  • LICENSE-MIT
  • package.json
  • PLAN.md
  • pnpm-lock.yaml
  • 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.
    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.
  • rust-toolchain.toml
  • tsconfig.json
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/sbdchd/squawk)](https://www.repo-grade.com/report/sbdchd/squawk)

More graded PLpgSQL repos