karlhorky/github-actions-database-persistence
Grade a repo

0

/ 100

GradeF

Some interest. A stronger README and CI would help.

GitHub Actions CRON workflow experiments with persisting CSV, SQLite and PostgreSQL databases to GitHub Actions cache and Git commits

Documentation41
Engineering30
Health89
TypeScript14today

Documentation

41

License6pt0

No license detected.

→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

README12pt75

README is present.

Engineering

30

Tests18pt0

No tests detected anywhere in the repository.

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

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.

CI/CD14pt40

CI is configured (.github/workflows/lint-check-types.yml).

Reproducibility6pt70

Lockfile present (pnpm-lock.yaml). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (eslint.config.js).

Project health

89

Dependency manifest6pt65

Dependency manifest found (package.json).

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)
  • 2
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 11h
    Median issue response
  • 4h
    Median PR merge time
  • 20
    Open issues
Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/lint-check-types.yml).
  • data
  • scripts
  • util
  • .gitignore
    Good: .gitignore present.
  • .npmrc
  • eslint.config.js
    Good: Linter or formatter configured (eslint.config.js).
  • package.json
    Good: Dependency manifest found (package.json).
  • persist-csv-database-to-cache-run-1.png
  • persist-csv-database-to-cache-run-2.png
  • persist-csv-database-to-cache-run-3.png
  • persist-csv-database-to-git-run-1.png
  • persist-csv-database-to-git-run-2.png
  • persist-csv-database-to-git-run-3.png
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • prettier.config.mjs
  • readme.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    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.
    Good: README documents how to run the project.
  • renovate.json
  • tsconfig.json