0
/ 100
Strong community interest, but tests, CI, or docs need work.
A guide to contributing to open source
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 B (83).
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
Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
- 3CI/CD14pt
Add a lint step to catch style issues automatically.
- 4CI/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.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
90
README is present.
Contributing guide is detailed and thorough.
README documents how to install the project.
Licensed under CC-BY-SA-4.0.
Engineering
39
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
No dependency lockfile found (−70 pts).
→ Commit Gemfile.lock so Bundler installs are repeatable.
CI is configured (.github/workflows/test.yml).
Linter or formatter configured (.eslintrc).
Issue or PR templates present.
Project health
47
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.
No pushes in over a year (−80 pts).
→ A recent commit signals the project is alive and worth contributing to.
Repository has a description.
.gitignore present.
Repository files45 root entries
- .githubGood: CI is configured (.github/workflows/test.yml).Good: Issue or PR templates present.
- .eslintrcGood: Linter or formatter configured (.eslintrc).
- .gitignoreGood: .gitignore present.
- CODE_OF_CONDUCT.mdGood: Code of conduct present.
- CONTRIBUTING.mdGood: 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.
- Dangerfile
- LICENSE.mdGood: Licensed under CC-BY-SA-4.0.
- PROJECTS.md
- README-AR.mdGood: 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.Good: README documents how to run the project.
- README-BG.md
- README-BN.md
- README-CN.md
- README-DE.md
- README-ES.md
- README-FA.md
- README-FR.md
- README-GR.md
- README-GU.md
- README-HE.md
- README-HI.md
- README-HY.md
- README-ID.md
- README-IT.md
- README-JA.md
- README-KO.md
- README-ML.md
- README-MR.md
- README-MS.md
- README-NE.md
- README-NL.md
- README-PL.md
- README-pt-BR.md
- README-RO.md
- README-RU.md
- README-SA.md
- README-SI.md
- README-SL.md
- README-TA.md
- README-TE.md
- README-TR.md
- README-UK.md
- README-UR.md
- README-UZ.md
- README-VI.md
- README.md
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/freecodecamp/how-to-contribute-to-open-source)