offchainlabs/arbitrum-docs
Grade a repo

86

/ 100

GradeB

Polished and well engineered. Punching above its star count.

Top 20% of 5,156 graded repos

Arbitrum Docs! Content + Webapp

Documentation77
Engineering87
Health100
JavaScript2471mo ago

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  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
    CI/CD14pt

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

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

77

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

README12pt70

README is present.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

A license file is present.

Engineering

87

Tests18pt80

Test files detected (lib/llms-tracking.test.ts).

CI/CD14pt85

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

Reproducibility6pt92

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

Linting and formatting5pt100

Linter or formatter configured (.prettierrc.js).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

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

  • 372 / 1177
    Commits (30d / 90d)
  • 449
    Forks
  • 0
    Releases

Community

  • 37% - Weak
    Community health
  • 2 bus factor
    authors own >50% of commits
  • 247
    Watchers

Responsiveness

  • 18d 8h
    Median issue response
  • 2h
    Median PR merge time
  • 44
    Open issues
Repository files31 root entries
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Dependabot configured for npm.
    Good: Issue or PR templates present.
  • .husky
  • docs
    Good: A license file is present.
  • i18n
  • lib
    Good: Test files detected (lib/llms-tracking.test.ts).
  • scripts
  • src
  • static
  • .env.example
  • .gitignore
    Good: .gitignore present.
  • .markdownlint.json
  • .node-version
    Good: Environment pinned via .node-version.
  • .prettierignore
  • .prettierrc.js
    Good: Linter or formatter configured (.prettierrc.js).
  • babel.config.js
  • CLAUDE.md
  • CONTRIBUTE.md
  • dependencies.json
  • docusaurus.config.js
  • inkeep.config.js
  • inkeep.js
  • middleware.ts
  • 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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • redirects.config.d.ts
  • redirects.config.js
  • sdk-sidebar.js
  • sidebars.js
  • tsconfig.json
  • vercel.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/offchainlabs/arbitrum-docs)](https://www.repo-grade.com/report/offchainlabs/arbitrum-docs)

More graded JavaScript repos