boatraceopenapi/results
Grade a repo

75

/ 100

GradeC

Solid engineering. The main gap is visibility.

Top 39% of 5,156 graded repos

🚤 Boatrace Open API for Results

Documentation56
Engineering78
Health100
PHP7MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

10 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 section showing how to install dependencies.

  3. 3
    Install and run instructions9pt

    Add a section showing how to start or use the project.

  4. 4
    Install and run instructions9pt

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

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

56

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

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.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

78

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

Reproducibility6pt82

Lockfile present (composer.lock). Installs are reproducible.

CI/CD14pt100

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

Linting and formatting5pt100

PHP linting configured (.editorconfig).

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)
  • 2
    Forks
  • 0
    Releases

Community

  • 50% - Fair
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 7
    Watchers

Responsiveness

  • -
    Median issue response
  • <1h
    Median PR merge time
  • 6
    Open issues
Repository files15 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yml).
    Good: Dependabot configured for github-actions.
  • docs
  • src
  • stubs
  • tests
  • .editorconfig
    Good: PHP linting configured (.editorconfig).
  • .gitignore
    Good: .gitignore present.
  • .nojekyll
  • composer.json
    Good: Dependency manifest found (composer.json).
  • composer.lock
    Good: Lockfile present (composer.lock). Installs are reproducible.
  • LICENSE
    Good: Licensed under MIT.
  • phpunit.xml.dist
    Good: Test files detected (phpunit.xml.dist).
  • psalm.xml.dist
  • 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.
    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.
  • scraper.php
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/boatraceopenapi/results)](https://www.repo-grade.com/report/boatraceopenapi/results)

More graded PHP repos