petebishwhip/laradocs

0

/ 100

Documentation94
Engineering71
Health100
PHP76MIT1d ago
Grade a repo

Strong early engineering with some momentum.

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

Documentation

94

Contributing guide5pt77

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

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)
  • 1
    Forks
  • 13
    Releaseslatest 6d ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 76
    Watchers

Responsiveness

  • 3d 2h
    Median issue response
  • <1h
    Median PR merge time
  • 14
    Open issues
Repository files28 root entries
  • .github
    Good: CI is configured (.github/workflows/tests.yml).
    Good: Dependabot covers 2 ecosystems (composer, npm). Dependencies stay current.
  • config
  • docs
  • resources
  • src
  • stubs
  • tests
  • .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
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    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
  • 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