0
/ 100
Just launched. The fastest wins are the README and fabrication outputs.
This is Flamingo & Cactuses open source inverter unit
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 (89).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1README12pt
Add an Overview, Install, Usage, and Contributing section at minimum.
- 2README12pt
Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
- 3README12pt
Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
- 4README12pt
Show a quick-start snippet so contributors can see what using your project looks like.
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
0
README is present.
No fabrication or ordering instructions in the README (−50 pts).
→ Add a section on how to get the board made: export gerbers, order from a fab (JLCPCB, PCBWay, OSH Park), and use the BOM.
No license detected.
→ Add a LICENSE file. Without one, nobody can legally use, copy, or contribute to your code.
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.
Engineering
90
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.
Dedicated design documentation is present.
Editable schematic source is committed (not just an image).
A bill of materials is committed.
Project health
100
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- 2 / 2Commits (30d / 90d)
- 0Forks
- 0Releases
Community
- 42% - WeakCommunity health
- 1 bus factorlowauthor own >50% of commits
- 0Watchers
Responsiveness
- -Median issue response
- -Median PR merge time
- 0Open issues
Repository files7 root entries
- HARDWAREGood: Dedicated design documentation is present.Good: Schematic or diagram visuals are included.Good: A bill of materials is committed.Good: .gitignore present.
- Images
- LICENSES
- SOFTWARE
- LICENSE-HARD
- LICENSE-SOFT
- 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.Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.Issue: No fabrication or ordering instructions in the README (−50 pts).Fix: Add a section on how to get the board made: export gerbers, order from a fab (JLCPCB, PCBWay, OSH Park), and use the BOM.Issue: No assembly or bring-up instructions in the README (−50 pts).Fix: Add steps for populating the board, wiring it up, and flashing firmware so others can reproduce your build.
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/bearjhartjen/lamoka1-half)