jupyter-book/thebe
Grade a repo

0

/ 100

GradeB

Polished and well engineered. Punching above its star count.

Top 14% of 5,156 graded repos

Turn static HTML pages into live documents with Jupyter kernels.

Documentation88
Engineering86
Health100
Jupyter Notebook439BSD-3-Clause1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    README12pt

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

  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 a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.

  4. 4
    Reproducibility6pt

    Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.

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

88

Contributing guide5pt75

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under BSD-3-Clause.

Engineering

86

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.

Reproducibility6pt82

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

Tests18pt100

Test files detected (packages/build-config/jest.config.cjs).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (.eslintrc.js).

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

  • -
    Commits (30d / 90d)
  • 68
    Forks
  • 13
    Releaseslatest 1y ago

Community

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

Responsiveness

  • 22h
    Median issue response
  • 23h
    Median PR merge time
  • 116
    Open issues
Repository files20 root entries
  • .changeset
  • .github
    Good: CI is configured (.github/workflows/ci-release.yml).
    Good: Dependabot configured for npm.
  • apps
    Good: Security policy present.
  • packages
    Good: Test files detected (packages/build-config/jest.config.cjs).
  • .eslintrc.js
    Good: Linter or formatter configured (.eslintrc.js).
  • .gitignore
    Good: .gitignore present.
  • .prettierignore
  • .prettierrc
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Good: Contributing guide includes setup/install instructions.
    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).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Good: Contributing guide includes code examples.
  • environment.demo.yml
  • environment.test.yml
  • LICENSE
    Good: Licensed under BSD-3-Clause.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • README_0.8.x.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
  • README.md
  • readthedocs.yml
  • turbo.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/jupyter-book/thebe)](https://www.repo-grade.com/report/jupyter-book/thebe)

More graded Jupyter Notebook repos