0
/ 100
Getting noticed, but rough fundamentals could turn visitors away.
๐ A compendium of CLI commands I can't stop looking up
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 D (61).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Add automated tests. They prove the code works and give contributors confidence to make changes.
- 2CI/CD14pt
If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
- 3README12pt
Add an Overview, Install, Usage, and Contributing section at minimum.
- 4README12pt
Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
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
38
No install instructions found in the README (โ45 pts).
โ Add a section showing how to install dependencies.
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.
README is present.
Licensed under Unlicense.
Engineering
0
No tests detected anywhere in the repository.
โ Add automated tests. They prove the code works and give contributors confidence to make changes.
No CI configuration detected in this repository.
โ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
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 dependency lockfile found (โ70 pts).
โ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.
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.
Project health
58
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)
- 20Forks
- 0Releases
Community
- -Community health
- -authors own >50% of commits
- 231Watchers
Responsiveness
- -Median issue response
- 9hMedian PR merge time
- 1Open issues
Repository files18 root entries
- .gitignoreGood: .gitignore present.
- bash.md
- bios.md
- docker.md
- edgeos.md
- emmet.md
- ffmpeg.md
- gradle.md
- LICENSE.mdGood: Licensed under Unlicense.
- mac.md
- mysql.md
- nix.md
- postgres.md
- python.md
- raspbian.md
- README.mdGood: README is present.Issue: README is very short (โ20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.Issue: README has little structure (โ15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.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.Issue: No install instructions found in the README (โ45 pts).Fix: Add a section showing how to install dependencies.Issue: No run or usage instructions found (โ45 pts).Fix: Add a section showing how to start or use the project.
- ubuntu.md
- virtualbox.md
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/fastily/cheatsheet)