phanxipang/fansipan
Grade a repo

62

/ 100

GradeB

Well engineered. The main gaps are a reproducible setup and the README.

Top 28% of 5,156 graded repos

A simple package that allows you to write your API integrations or SDKs in a elegant way.

Documentation83
Engineering76
Health100
PHP89MIT19d ago

Top fixes

Highest-impact changes first, ranked by point weight

12 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
    CI/CD14pt

    Add `pull_request:` to the workflow `on:` triggers.

  3. 3
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  4. 4
    README12pt

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

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

83

README12pt70

README is present.

Contributing guide5pt79

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

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

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

76

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit composer.lock so Composer installs are repeatable.

Tests18pt80

Test files detected (phpunit.xml.dist).

CI/CD14pt83

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

Linting and formatting5pt100

PHP linting configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

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
  • 21
    Releaseslatest 2y ago

Community

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

Responsiveness

  • 43d 4h
    Median issue response
  • <1h
    Median PR merge time
  • 4
    Open issues
Repository files18 root entries
  • .github
    Good: CI is configured (.github/workflows/testing.yml).
    Good: Issue or PR templates present.
  • docs
  • src
  • stubs
  • tests
  • .editorconfig
    Good: PHP linting configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .php-cs-fixer.dist.php
  • 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 too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • LICENSE.md
    Good: Licensed under MIT.
  • phpstan-baseline.neon
  • phpstan.dist.neon
  • phpunit.xml.dist
    Good: Test files detected (phpunit.xml.dist).
  • 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.
    Good: README has code examples.
    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.
    Good: README documents how to run the project.
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/phanxipang/fansipan)](https://www.repo-grade.com/report/phanxipang/fansipan)

More graded PHP repos