openrewrite/rewrite-docs

0

/ 100

Documentation62
Engineering54
Health100
HTML53Apache-2.01d ago
Grade a repo

Getting some notice. Tests and CI would be the fastest wins.

Stores the markdown documents used to generate docs.openrewrite.org

Documentation

62

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.

Install and run instructions9pt45

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

README12pt70

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

54

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

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.

CI/CD14pt57

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

Reproducibility6pt70

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

Tests18pt80

Test files detected (docs/recipes/java/spring/test).

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)
  • 79
    Forks
  • 1
    Releaseslatest 1y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 53
    Watchers

Responsiveness

  • 8d 10h
    Median issue response
  • <1h
    Median PR merge time
  • 4
    Open issues
Repository files16 root entries
  • .claude
  • .github
    Good: CI is configured (.github/workflows/unneeded_recipe_updates.yml).
  • docs
    Good: Test files detected (docs/recipes/java/spring/test).
  • scripts
  • src
  • static
  • .gitignore
    Good: .gitignore present.
  • .markdownlint.yml
  • CNAME
  • docusaurus.config.ts
  • LICENSE
    Good: Licensed under Apache-2.0.
  • 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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.
  • sidebars.ts
  • tsconfig.json
  • yarn.lock
    Good: Lockfile present (yarn.lock). Installs are reproducible.