petebishwhip/laradocs
Grade a repo

84

/ 100

GradeB

Well engineered. The main gaps are issue and PR templates and a reproducible setup.

Top 24% of 5,156 graded repos

Maintain beautiful, version-controlled documentation alongside your Laravel codebase. Markdown in, a polished docs site out.

Documentation95
Engineering71
Health100
PHP107MIT17d ago

Top fixes

Highest-impact changes first, ranked by point weight

7 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  3. 3
    Reproducibility6pt

    Commit composer.lock so Composer installs are repeatable.

  4. 4
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

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

95

Contributing guide5pt89

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

71

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.

Reproducibility6pt20

No dependency lockfile found (−70 pts).

→ Commit composer.lock so Composer installs are repeatable.

Tests18pt80

Test files detected (phpunit.xml).

CI/CD14pt100

CI is configured (.github/workflows/tests.yml).

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)
  • 4
    Forks
  • 16
    Releaseslatest 1mo ago

Community

  • 85% - Good
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 107
    Watchers

Responsiveness

  • 7d 17h
    Median issue response
  • <1h
    Median PR merge time
  • 2
    Open issues
Repository files31 root entries
  • .github
    Good: CI is configured (.github/workflows/tests.yml).
    Good: Dependabot covers 3 ecosystems (composer, npm, github-actions). Dependencies stay current.
  • config
  • docs
  • resources
  • src
  • stubs
  • tests
  • workbench
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • composer.json
    Good: Dependency manifest found (composer.json).
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • crowdin.yml
  • LICENSE.md
    Good: Licensed under MIT.
  • package.json
  • phpstan.neon
    Good: PHP linting configured (phpstan.neon).
  • phpunit.xml
    Good: Test files detected (phpunit.xml).
  • pint.json
  • playwright.config.ts
  • psalm-baseline.xml
  • psalm.xml
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • rector.php
  • SECURITY.md
    Good: Security policy present.
  • sonar-project.properties
  • sponsor.config.ts
  • sponsors.png
  • sponsors.svg
  • testbench.yaml
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/petebishwhip/laradocs)](https://www.repo-grade.com/report/petebishwhip/laradocs)

More graded PHP repos