code-br3aker/uswds
Grade a repo

0

/ 100

GradeB

Polished work that hasn't found its audience yet.

Top 16% of 5,156 graded repos

The U.S. Web Design System helps the federal government build fast, accessible, mobile-friendly websites.

Documentation90
Engineering98
Health62
0Other6y ago

Top fixes

Highest-impact changes first, ranked by point weight

6 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
    Install and run instructions9pt

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

  3. 3
    Reproducibility6pt

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

  4. 4
    Dependency manifest6pt

    Add a `keywords` array to help people find your package on npm.

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

90

README12pt80

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Contributing guide5pt100

Contributing guide is detailed and thorough.

Engineering

98

Reproducibility6pt80

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

Tests18pt100

Test files detected (spec).

CI/CD14pt100

CI is configured (.circleci/config.yml).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

62

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

→ A recent commit signals the project is alive and worth using.

Repository metadata5pt60

Repository has a description.

Dependency manifest6pt92

Dependency manifest found (package.json).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • -
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files27 root entries
  • .circleci
    Good: CI is configured (.circleci/config.yml).
  • .github
    Good: Issue or PR templates present.
  • config
  • docs
  • examples
  • spec
    Good: Test files detected (spec).
  • src
  • _config.yml
  • .browserslistrc
  • .codeclimate.yml
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .eslintignore
  • .eslintrc.yml
  • .gitignore
    Good: .gitignore present.
  • .npmignore
  • .nvmrc
    Good: Environment pinned via .nvmrc.
  • .prettierignore
  • .snyk
  • .stylelintrc.json
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • fractal.config.js
  • gulpfile.js
  • LICENSE.md
    Good: Licensed under Other.
  • 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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • tsconfig.json
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/code-br3aker/uswds)](https://www.repo-grade.com/report/code-br3aker/uswds)

More graded repos