minituff/nautical-backup
Grade a repo

0

/ 100

GradeB

Good shape overall. A few tweaks would push it into the top tier.

Top 32% of 5,156 graded repos

A simple Docker volume backup tool.

Documentation79
Engineering81
Health79
Python444GPL-3.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

17 to address
  1. 1
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  2. 2
    CI/CD14pt

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

  3. 3
    README12pt

    Add more sections (Overview, Install, Usage, Contributing) using ## headings.

  4. 4
    Install and run instructions9pt

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

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

79

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 instructions9pt90

README documents how to install the project.

README12pt93

README is present.

License6pt100

Licensed under GPL-3.0.

Engineering

81

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 (requirements.txt). Installs are reproducible.

CI/CD14pt85

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

Tests18pt100

Test files detected (pytest/test_api.py).

Linting and formatting5pt100

Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).

Project health

79

Dependency manifest6pt55

Dependency manifest found (pyproject.toml).

Housekeeping3pt60

.gitignore present.

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 7
    Forks
  • 244
    Releaseslatest 2y ago

Community

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

Responsiveness

  • 4h
    Median issue response
  • <1h
    Median PR merge time
  • 10
    Open issues
Repository files22 root entries
  • .claude
  • .devcontainer
    Good: Environment pinned via .devcontainer/Dockerfile.
  • .github
    Good: CI is configured (.github/workflows/test_docker_image.yml).
  • app
  • dev
    Issue: Build artifacts or local files may be committed (dev/.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • docs
  • pytest
    Good: Test files detected (pytest/test_api.py).
  • s6-overlay
  • snippets
  • tests
  • .dockerignore
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • AGENTS.md
  • Dockerfile
  • LICENSE
    Good: Licensed under GPL-3.0.
  • mkdocs.yml
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.md
    Good: README is present.
    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.
    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.
  • requirements-dev.txt
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
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/minituff/nautical-backup)](https://www.repo-grade.com/report/minituff/nautical-backup)

More graded Python repos