0

/ 100

GradeB

A well-known project done right. Strong docs and solid engineering throughout.

Top 16% of 5,156 graded repos

Configure AWS credential environment variables for use in other GitHub Actions.

TypeScript2,951MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

11 to address
  1. 1
    README12pt

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

  2. 2
    README12pt

    Add CI/build status badges from shields.io or your CI provider to signal project health.

  3. 3
    Install and run instructions9pt

    Add a section showing how to install dependencies.

  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

69

Install and run instructions9pt45

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

Add a section showing how to install dependencies.

README12pt70

README is present.

Contributing guide5pt72

Contributing guide is detailed and thorough.

License6pt100

Licensed under MIT.

Engineering

98

Reproducibility6pt82

Lockfile present (package-lock.json). Installs are reproducible.

Tests18pt100

Test files detected (test).

CI/CD14pt100

CI is configured (.github/workflows/tests-integ-push.yml).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

97

Dependency manifest6pt90

Dependency manifest found (package.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)
  • 572
    Forks
  • 59
    Releaseslatest 6y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 2,951
    Watchers

Responsiveness

  • 2d 22h
    Median issue response
  • 1d 6h
    Median PR merge time
  • 0
    Open issues
Repository files26 root entries
  • __mocks__
  • .github
    Good: CI is configured (.github/workflows/tests-integ-push.yml).
    Good: Dependabot configured for npm.
    Good: Issue or PR templates present.
  • dist
  • examples
  • src
  • test
    Good: Test files detected (test).
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .generatelicensefile.json
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .markdownlint.yaml
  • .release-please-manifest.json
  • action.yml
  • biome.jsonc
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • LICENSE
    Good: Licensed under MIT.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • 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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.
  • release-please-config.json
  • THIRD-PARTY
  • tsconfig.json
  • tsconfig.test.json
  • vitest.config.mts
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/aws-actions/configure-aws-credentials)](https://www.repo-grade.com/report/aws-actions/configure-aws-credentials)

More graded TypeScript repos