pgsql-jp/jpug-doc
Grade a repo

66

/ 100

GradeD

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

Top 50% of 5,156 graded repos

PostgreSQL database manual Japanese translation by Japan PostgreSQL Users Group

Documentation48
Engineering76
Health68
C171Other1mo 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 C (78).

See your top fixes
Now
D
66
Potential
C
78

Top fixes

Highest-impact changes first, ranked by point weight

16 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  3. 3
    CI/CD14pt

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

  4. 4
    CI/CD14pt

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

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

48

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

README12pt45

README is present.

Contributing guide5pt77

CONTRIBUTING guide found.

License6pt100

Licensed under Other.

Engineering

76

Reproducibility6pt0

No dependency lockfile found (−70 pts).

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

Tests18pt80

Test files detected (src/interfaces/ecpg/test).

CI/CD14pt85

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

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

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

  • 31 / 165
    Commits (30d / 90d)
  • 89
    Forks
  • 27
    Releaseslatest 9y ago

Community

  • 75% - Good
    Community health
  • 3 bus factor
    authors own >50% of commits
  • 171
    Watchers

Responsiveness

  • 7d 11h
    Median issue response
  • 1h
    Median PR merge time
  • 65
    Open issues
Repository files26 root entries
  • .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/test.yml).
    Good: Issue or PR templates present.
    Good: Security policy present.
  • config
  • contrib
  • doc
  • src
    Good: Test files detected (src/interfaces/ecpg/test).
  • .abi-compliance-history
  • .cirrus.star
  • .cirrus.tasks.yml
  • .cirrus.yml
  • .dir-locals.el
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .mailmap
  • .ng.list
  • aclocal.m4
  • configure
  • configure.ac
  • COPYRIGHT
  • GNUmakefile.in
  • HISTORY
  • Makefile
  • meson_options.txt
  • meson.build
  • 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.
    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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
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/pgsql-jp/jpug-doc)](https://www.repo-grade.com/report/pgsql-jp/jpug-doc)

More graded C repos