streamich/react-use
Grade a repo

89

/ 100

GradeA

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Top 10% of 5,156 graded repos

React Hooks — 👍

Documentation82
Engineering96
Health97
TypeScript43,986Unlicense1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

10 to address
  1. 1
    README12pt

    Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.

  2. 2
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

  3. 3
    Install and run instructions9pt

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

  4. 4
    Reproducibility6pt

    Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

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

README12pt70

README is present.

Contributing guide5pt72

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Unlicense.

Engineering

96

Reproducibility6pt70

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

Tests18pt100

Test files detected (jest.config.ts).

CI/CD14pt100

CI is configured (.github/workflows/check-codebase.yml).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

97

Dependency manifest6pt92

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

  • 1 / 1
    Commits (30d / 90d)
  • 3,273
    Forks
  • 257
    Releaseslatest 7y ago

Community

  • 85% - Good
    Community health
  • 2 bus factor
    authors own >50% of commits
  • 43,986
    Watchers

Responsiveness

  • 12h
    Median issue response
  • <1h
    Median PR merge time
  • 660
    Open issues
Repository files23 root entries
  • .github
    Good: CI is configured (.github/workflows/check-codebase.yml).
    Good: Issue or PR templates present.
  • .storybook
  • docs
  • src
  • stories
  • tests
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .eslintrc.js
  • .gitignore
    Good: .gitignore present.
  • .travis.yml
  • babel.config.js
  • CHANGELOG.md
  • 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.
    Good: Contributing guide includes code examples.
  • jest.config.base.ts
  • jest.config.node.ts
  • jest.config.ts
    Good: Test files detected (jest.config.ts).
  • LICENSE
    Good: Licensed under Unlicense.
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    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.
  • renovate.json
  • SECURITY.md
    Good: Security policy present.
  • 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/streamich/react-use)](https://www.repo-grade.com/report/streamich/react-use)

More graded TypeScript repos