phorus-group/ci-assistant-action
Grade a repo

0

/ 100

GradeC

Solid engineering. The biggest lever is CI.

Top 38% of 5,156 graded repos
Documentation82
Engineering73
Health74
TypeScript0Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

13 to address
  1. 1
    CI/CD14pt

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  2. 2
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  3. 3
    CI/CD14pt

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

  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

82

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.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

73

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.

CI/CD14pt57

CI is configured (.github/workflows/ci-assistant.yml).

Reproducibility6pt80

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

Tests18pt100

Test files detected (jest.config.js).

Linting and formatting5pt100

Linter or formatter configured (.prettierrc).

Project health

74

Repository metadata5pt40

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Activity5pt80

Actively maintained (pushed within 3 months).

Dependency manifest6pt83

Dependency manifest found (package.json).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • 0 / 2
    Commits (30d / 90d)
  • 0
    Forks
  • 19
    Releaseslatest 5mo ago

Community

  • 37% - Weak
    Community health
  • -
    authors own >50% of commits
  • 0
    Watchers

Responsiveness

  • -
    Median issue response
  • <1h
    Median PR merge time
  • 0
    Open issues
Repository files16 root entries
  • .github
    Good: CI is configured (.github/workflows/ci-assistant.yml).
  • .husky
  • src
  • test
  • .gitignore
    Good: .gitignore present.
  • .nvmrc
    Good: Environment pinned via .nvmrc.
  • .prettierrc
    Good: Linter or formatter configured (.prettierrc).
  • action.yml
  • eslint.config.mjs
  • jest.config.js
    Good: Test files detected (jest.config.js).
  • jest.resolver.js
  • LICENSE
    Good: Licensed under Apache-2.0.
  • package.json
    Good: Dependency manifest found (package.json).
  • 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.
  • tsconfig.json
  • yarn.lock
    Good: Lockfile present (yarn.lock). Installs are reproducible.
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/phorus-group/ci-assistant-action)](https://www.repo-grade.com/report/phorus-group/ci-assistant-action)

More graded TypeScript repos