knivey/lolbot

0

/ 100

Documentation50
Engineering40
Health100
PHP13MIT4d ago
Grade a repo

Getting some notice. Tests and CI would be the fastest wins.

A PHP IRC bot written to use with my friends

Documentation

50

Contributing guide5pt0

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.

Install and run instructions9pt45

README documents how to install the project.

README12pt50

README is present.

License6pt100

Licensed under MIT.

Engineering

40

CI/CD14pt0

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.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit composer.lock so Composer installs are repeatable.

Issue and PR templates6pt0

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.

Tests18pt80

Test files detected (phpunit.xml).

Linting and formatting5pt100

PHP linting configured (phpstan.neon).

Project health

100

Dependency manifest6pt100

Dependency manifest found (composer.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 8
    Forks
  • —
    Releases

Community

  • 42% - Weak
    Community health
  • —
    authors own >50% of commits
  • 13
    Watchers

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 43
    Open issues
Repository files30 root entries
  • .vscode
  • artbot_scripts
  • cli_cmds
  • docs
  • entities
  • library
  • Migrations
  • scripts
  • tests
  • web
  • .gitignore
    Good: .gitignore present.
  • admin-cli.php
  • artbot_rest_server.php
  • artbots.php
  • artbotsconfig.example.yaml
  • bootstrap.php
  • cli-config.php
  • composer.json
    Good: Dependency manifest found (composer.json).
  • config.example.yaml
  • doctrine-cli.php
  • LICENSE.txt
    Good: Licensed under MIT.
  • lolbot.php
  • migrate_artconfig_plan.md
  • migrate_artconfig.php
  • migrations.yml
  • NetworkContext.php
  • phpstan.neon
    Good: PHP linting configured (phpstan.neon).
  • phpunit.xml
    Good: Test files detected (phpunit.xml).
  • psalm.xml
  • README.md
    Good: 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.