jupyter-book/thebe

0

/ 100

Documentation88
Engineering86
Health100
Jupyter Notebook439BSD-3-Clause1d ago
Grade a repo

Polished and well engineered. Punching above its star count.

Turn static HTML pages into live documents with Jupyter kernels.

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