creativeprojects/resticprofile
Grade a repo

86

/ 100

GradeB

Well engineered. The main gaps are issue and PR templates and setup instructions.

Top 20% of 5,156 graded repos

Configuration profiles manager and scheduler for restic backup

Documentation77
Engineering86
Health100
Go1,362GPL-3.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

8 to address
  1. 1
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

  2. 2
    Install and run instructions9pt

    Add a section showing how to start or use the project.

  3. 3
    Install and run instructions9pt

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

  4. 4
    Reproducibility6pt

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

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

77

Install and run instructions9pt45

README documents how to install the project.

README12pt85

README is present.

Contributing guide5pt88

Contributing guide is detailed and thorough.

License6pt100

Licensed under GPL-3.0.

Engineering

86

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.

Reproducibility6pt85

Lockfile present (go.sum). Installs are reproducible.

Tests18pt100

Test files detected (batt/battery_test.go).

CI/CD14pt100

CI is configured (.github/workflows/run-tests-os.yml).

Linting and formatting5pt100

Formatting enforced (.golangci.yml).

Project health

100

Dependency manifest6pt100

Dependency manifest found (go.mod).

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)
  • 66
    Forks
  • 54
    Releaseslatest 6y ago

Community

  • 57% - Fair
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 1,362
    Watchers

Responsiveness

  • 3h
    Median issue response
  • 1d 24h
    Median PR merge time
  • 92
    Open issues
Repository files105 root entries
  • .github
    Good: CI is configured (.github/workflows/run-tests-os.yml).
  • .vscode
  • batt
    Good: Test files detected (batt/battery_test.go).
  • build
    Good: Environment pinned via build/Dockerfile.
  • calendar
  • checklinks
  • config
  • constants
  • contrib
  • crond
  • darwin
  • dial
  • docs
  • examples
  • filesearch
  • fuse
  • lock
  • mask
  • monitor
  • platform
  • preventsleep
  • priority
  • remote
  • restic
  • schedule
  • schtasks
  • scripts
  • shell
  • ssh
  • systemd
  • term
  • testhelpers
  • user
  • util
  • win
  • .envrc
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .godownloader.yml
  • .golangci.yml
    Good: Formatting enforced (.golangci.yml).
  • .goreleaser-docker-only.yml
  • .goreleaser.yml
  • .mockery.yml
  • .nojekyll
  • codecov.yml
  • command_error.go
  • commands_display_test.go
  • commands_display.go
  • commands_generate.go
  • commands_schedule_test.go
  • commands_schedule.go
  • commands_test.go
  • commands.go
  • complete_test.go
  • complete.go
  • completion_shell_test.go
  • context_test.go
  • context.go
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • deprecation.go
  • errors.go
  • flags_test.go
  • flags.go
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • install.sh
  • integration_test.go
  • LICENSE
    Good: Licensed under GPL-3.0.
  • lock_test.go
  • lock.go
  • logger_test.go
  • logger.go
  • main_test.go
  • main.go
  • Makefile
  • network_volume.png
  • own_command_error_test.go
  • own_command_error.go
  • own_commands_test.go
  • own_commands.go
  • 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • remote_fuse_test.go
  • remote_test.go
  • remote.go
  • run_profile_test.go
  • run_profile.go
  • schedule_jobs_test.go
  • schedule_jobs.go
  • serve_test.go
  • serve.go
  • shell_command.go
  • sleep_test.go
  • sleep.go
  • stack_test.go
  • stack.go
  • syslog_windows.go
  • syslog.go
  • systemd_others.go
  • systemd.go
  • update_test.go
  • update.go
  • wrapper_streamsource.go
  • wrapper_test.go
  • wrapper_unix_test.go
  • wrapper.go
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/creativeprojects/resticprofile)](https://www.repo-grade.com/report/creativeprojects/resticprofile)

More graded Go repos