caseyamcl/toc

0

/ 100

Documentation31
Engineering68
Health84
PHP89MIT6mo ago
Grade a repo

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

Table of Contents Generator for HTML Markup

Documentation

31

README12pt0

No README found in the repository.

→ Add a README.md describing what the project does, how to install it, and how to run it.

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

Contributing guide5pt77

CONTRIBUTING guide found.

License6pt100

Licensed under MIT.

Engineering

68

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.dist).

CI/CD14pt100

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

Linting and formatting5pt100

PHP linting configured (.editorconfig).

Project health

84

Activity5pt40

Last pushed 6-12 months ago (−60 pts).

→ A recent commit signals the project is still maintained.

Dependency manifest6pt100

Dependency manifest found (composer.json).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

Repository files17 root entries
  • .github
    Good: CI is configured (.github/workflows/php.yml).
  • src
  • tests
  • .editorconfig
    Good: PHP linting configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .styleci
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • composer.json
    Good: Dependency manifest found (composer.json).
  • CONTRIBUTING.md
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
  • coverage.svg
  • LICENSE.md
    Good: Licensed under MIT.
  • phpunit.xml.dist
    Good: Test files detected (phpunit.xml.dist).
  • PULL_REQUEST_TEMPLATE.md
  • README.md
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • UPGRADE.md