fredm67/pvrouter-3-phase
Grade a repo

0

/ 100

GradeD

A workable base with real gaps. Start with CI and dependency metadata.

Top 49% of 5,156 graded repos

My version of the 3-phase Mk2PVRouter firmware (see http://www.mk2pvrouter.co.uk)

Documentation77
Engineering59
Health68
C++19GPL-3.027d 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
67
Potential
C
78

Top fixes

Highest-impact changes first, ranked by point weight

15 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 step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  3. 3
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  4. 4
    CI/CD14pt

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

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 guide5pt89

Contributing guide is detailed and thorough.

License6pt100

Licensed under GPL-3.0.

Engineering

59

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

Reproducibility6pt12

No dependency lockfile found (−70 pts).

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

CI/CD14pt57

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

Tests18pt80

Test files detected (Mk2_3phase_RFdatalog_temp/test).

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

  • 8 / 11
    Commits (30d / 90d)
  • 10
    Forks
  • 0
    Releases

Community

  • 100% - Good
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 19
    Watchers

Responsiveness

  • 3h
    Median issue response
  • <1h
    Median PR merge time
  • 6
    Open issues
Repository files26 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • analysis
  • dev
  • docs
  • extras
  • img
  • lang
  • Mk2_3phase_RFdatalog_temp
    Good: Test files detected (Mk2_3phase_RFdatalog_temp/test).
  • obsolete
  • schematics
  • .clang-format
  • .clang-tidy
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • Doxyfile
  • formatter.sh
  • Gallery.md
  • LICENSE
    Good: Licensed under GPL-3.0.
  • PVRouter-3-phase.code-workspace
  • Readme.en.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.
  • Readme.md
  • run-clang-format.py
  • SECURITY.md
    Good: Security policy present.
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/fredm67/pvrouter-3-phase)](https://www.repo-grade.com/report/fredm67/pvrouter-3-phase)

More graded C++ repos