0
/ 100
Good shape overall. A few tweaks would push it into the top tier.
A nfs diagnostic application
Top fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
- 2CI/CD14pt
Add a lint step to catch style issues automatically.
- 3CI/CD14pt
Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
- 4Install 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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
95
Contributing guide is detailed and thorough.
README documents how to install the project.
README is present.
Licensed under MIT.
Engineering
57
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.
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.
No dependency lockfile found (−70 pts).
→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.
Test files detected (tests).
CI is configured (.github/workflows/ci.yml).
Project health
68
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 has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 5Forks
- 8Releaseslatest 1mo ago
Community
- -Community health
- -authors own >50% of commits
- 147Watchers
Responsiveness
- -Median issue response
- -Median PR merge time
- 7Open issues
Repository files20 root entries
- .githubGood: CI is configured (.github/workflows/ci.yml).Good: Dependabot covers 2 ecosystems (github-actions, docker). Dependencies stay current.
- completions
- dockerfiles
- docs
- packagingGood: Environment pinned via packaging/Dockerfile.
- src
- testsGood: Test files detected (tests).
- website
- .clang-tidy
- .gitignoreGood: .gitignore present.
- CHANGELOG.md
- CODE_OF_CONDUCT.mdGood: Code of conduct present.
- CONTRIBUTING.mdGood: 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.Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.Good: Contributing guide explains how to run tests.Good: Contributing guide describes the PR/review workflow.Good: Contributing guide includes code examples.
- flake.nix
- LICENSEGood: Licensed under MIT.
- Makefile
- README.mdGood: README is present.Good: README is well structured with multiple sections.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.
- SECURITY.mdGood: Security policy present.
- VERSION
- wrangler.jsonc
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/lsferreira42/nfsdiag)