54
/ 100
Getting some notice. Tests and CI would be the fastest wins.
A PHP IRC bot written to use with my friends
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 C (78).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
- 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 a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
- 4README12pt
Link to a deployed version, docs site, or demo video. Users want to see it running.
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
50
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 documents how to install the project.
README is present.
Licensed under MIT.
Engineering
40
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 dependency lockfile found (−70 pts).
→ Commit composer.lock so Composer installs are repeatable.
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 (phpunit.xml).
PHP linting configured (phpstan.neon).
Project health
100
Dependency manifest found (composer.json).
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)
- 8Forks
- 0Releases
Community
- 42% - WeakCommunity health
- 1 bus factorlowauthor own >50% of commits
- 13Watchers
Responsiveness
- 1277dMedian issue response
- <1hMedian PR merge time
- 44Open issues
Repository files30 root entries
- .vscode
- artbot_scripts
- cli_cmds
- docs
- entities
- library
- Migrations
- scripts
- tests
- web
- .gitignoreGood: .gitignore present.
- admin-cli.php
- artbot_rest_server.php
- artbots.php
- artbotsconfig.example.yaml
- bootstrap.php
- cli-config.php
- composer.jsonGood: Dependency manifest found (composer.json).
- config.example.yaml
- doctrine-cli.php
- LICENSE.txtGood: Licensed under MIT.
- lolbot.php
- migrate_artconfig_plan.md
- migrate_artconfig.php
- migrations.yml
- NetworkContext.php
- phpstan.neonGood: PHP linting configured (phpstan.neon).
- phpunit.xmlGood: Test files detected (phpunit.xml).
- psalm.xml
- README.mdGood: README is present.Good: README is well structured with multiple sections.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.Good: README has code examples.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.Good: README documents how to install the project.Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/knivey/lolbot)