Lots of room to improve. Start with a README and CI.
Based on https://github.com/xarantolus/bromite-userscripts
Documentation
28
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.
README is present.
Engineering
20
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
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.
CI is configured (.github/workflows/auto-generate.yml).
Lockfile present (generate/cosmetic/go.sum). Installs are reproducible.
Project health
91
No .gitignore found (−60 pts).
→ Add a .gitignore to keep build output, node_modules, and secrets out of version control.
Dependency manifest found (generate/cosmetic/go.mod).
Repository has a description.
Actively maintained (pushed within the last month).
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- —Commits (30d / 90d)
- 1Forks
- 0Releases
Community
- —Community health
- —authors own >50% of commits
- 7Watchers
Responsiveness
- —Median issue response
- —Median PR merge time
- 0Open issues
Repository files4 root entries
- .githubGood: CI is configured (.github/workflows/auto-generate.yml).
- generateGood: Lockfile present (generate/cosmetic/go.sum). Installs are reproducible.Good: Dependency manifest found (generate/cosmetic/go.mod).
- cosmetic.user.js
- README.mdGood: README is present.Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.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.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.