pgsql-jp/jpug-doc

0

/ 100

Documentation48
Engineering76
Health68
C171Other1d ago
Grade a repo

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

PostgreSQL database manual Japanese translation by Japan PostgreSQL Users Group

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

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

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 171
    Watchers

Responsiveness

  • 7d 11h
    Median issue response
  • 1h
    Median PR merge time
  • 64
    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.