0
/ 100
Some interest. A stronger README and CI would help.
Documentation
0
README is present.
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
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
29
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.
Test files detected (hollow_clock/test).
Project health
37
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 .gitignore found (−60 pts).
→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.
No repository description set on GitHub (−60 pts).
→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.
Actively maintained (pushed within the last month).
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- -Commits (30d / 90d)
- 0Forks
- 0Releases
Community
- -Community health
- -authors own >50% of commits
- 18Watchers
Responsiveness
- -Median issue response
- -Median PR merge time
- 3Open issues
Repository files68 root entries
- AC_01
- AIR_COVER
- air_cube
- air_cube_homekit
- air_cube_pro
- AIR_DUAL
- AIR_FAN
- AIR_GAS
- AIR_ONE
- AIR_Three
- AS_3
- AS-P3
- auto_space
- auto_space_II
- BASIC_R4
- BluePrint
- cb3s-curtain
- components
- customer_made
- Dashboard_delta
- dashboard_one
- dashboard_one_twIssue: Build artifacts or local files may be committed (dashboard_one_tw/my_components/gc9503v/__pycache__/README.md) (−40 pts).Fix: Remove them and add to .gitignore.
- e_ink_display
- ED_29
- electricity_meter_pro_20way
- garage_door
- garage_door_ii
- GD_3
- GD_3_homekit
- GR_1
- GR_1C3
- hollow_clockGood: Test files detected (hollow_clock/test).
- ikea_air_purifier
- LIGHT
- LuxOne
- mb_test
- module_switch
- motion_mmWave
- Motion_One_Plus
- Motion_One_Pro
- OS_04
- PANEL
- Pixel_Light
- PM_02
- PM_02a
- PM_02b
- PM_20
- PM_20_LCD_Display
- PM_20d
- PM_3F
- PM_OL
- puzzles_lamps
- QR_CODE
- SH_01
- sonoff_s31_ultimate
- SW_02
- VibeSense
- wall_switch
- wall_switch_no_neutral
- weatherpanel-auto
- WL_01
- WL_01a
- WL_01b
- WP_475
- wt32_electricity
- 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 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.
- sonoff-r4-matter-1.0.2.bin
- version.json