0

/ 100

GradeF

Some interest. A stronger README and CI would help.

Higher than 21% of 5,156 graded repos

Easy to use Slack Inviter running on Google App Engine

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 D (68).

See your top fixes
Now
F
31
Potential
D
68

Top fixes

Highest-impact changes first, ranked by point weight

16 to address
  1. 1
    Tests18pt

    Add automated tests. They prove the code works and give contributors confidence to make changes.

  2. 2
    CI/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.

  3. 3
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  4. 4
    README12pt

    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.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

52

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.

README12pt55

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

0

Tests18pt0

No tests detected anywhere in the repository.

Add automated tests. They prove the code works and give contributors confidence to make changes.

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.

Linting and formatting5pt0

No PHP linter or static analysis tool configured.

Add PHP_CodeSniffer (phpcs.xml) for style or PHPStan (phpstan.neon) for static analysis. Run either in CI.

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.

Project health

75

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

A recent commit signals the project is alive and worth using.

Dependency manifest6pt100

Dependency manifest found (composer.json).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files11 root entries
  • .gitignore
    Good: .gitignore present.
  • app.yaml
  • composer.json
    Good: Dependency manifest found (composer.json).
  • constants.php.example
  • CONTRIBUTORS
  • index.php
  • LICENSE
    Good: Licensed under Apache-2.0.
  • php.ini
  • 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.
    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.
    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.
  • signup.php
  • style.css
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/thesandlord/slackengine)](https://www.repo-grade.com/report/thesandlord/slackengine)

More graded PHP repos