phanxipang/fansipan

0

/ 100

Documentation31
Engineering71
Health89
PHP89MIT4mo ago
Grade a repo

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

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

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

71

Reproducibility6pt0

No dependency lockfile found (−70 pts).

→ Commit composer.lock so Composer installs are repeatable.

CI/CD14pt68

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

Tests18pt80

Test files detected (phpunit.xml.dist).

Linting and formatting5pt100

PHP linting configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

89

Activity5pt60

Last pushed 3-6 months ago (−40 pts). A push within 90 days earns 80 pts; within 30 days earns 100 pts.

→ A recent commit keeps the project looking alive to visitors and contributors.

Dependency manifest6pt100

Dependency manifest found (composer.json).

Repository metadata5pt100

Repository has a description.

Housekeeping3pt100

.gitignore present.

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
    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.
  • LICENSE.md
    Good: Licensed under MIT.
  • phpstan-baseline.neon
  • phpstan.dist.neon
  • phpunit.xml.dist
    Good: Test files detected (phpunit.xml.dist).
  • 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.