poem-web/poemNew scan
83/ 100 · B

Good community traction and solid fundamentals. Nearly in the top tier.

A full-featured and easy-to-use web framework with the Rust programming language.

Rust4,404 starsApache-2.0updated 1mo ago
DocumentationREADME, setup, examples, license
67
EngineeringTests, CI, linting, lockfiles
90
Project healthDescription, activity, stars, deps
92

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  2. 2
    README
    DocumentationWarning

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

  3. 3
    README
    DocumentationInfo

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

Detailed breakdown

Documentation

67
  • README65
    • README is present.
    • README is well structured with multiple sections.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • README has no code examples (−15 pts).Show a quick-start snippet so contributors can see what using your project looks like.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions45
    • No install instructions found in the README (−45 pts).Add a section showing how to install dependencies.
    • README documents how to run the project.
    • If your project uses environment variables, add a .env.example listing them (+10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under Apache-2.0.
  • Contributing guide70
    • CONTRIBUTING guide or docs directory present.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

90
  • Tests90
    • Test files detected (poem-mcpserver/tests).
    • Rust workspace with test files detected. Run with `cargo test --workspace`.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/ci.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • CI reports or uploads test coverage.
    • CI tests across multiple environments or versions.
  • Linting and formatting80
    • Rust linting enforced in CI: cargo clippy + cargo fmt.
  • Reproducibility62
    • No Cargo.lock committed. Correct for Rust library crates (Rust ecosystem convention).For Rust binaries/applications, commit Cargo.lock. For library-only crates, omitting it is the recommended practice per the Cargo guide.
    • No Dockerfile or runtime version pin found. Adding one earns +10 pts.Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
    • Dependabot configured for cargo.
    • Dependabot only covers one ecosystem (+12 pts; covering 2+ earns +20 pts).Add additional package-ecosystem entries (especially github-actions) to keep all dependencies current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

92
  • Dependency manifest100
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml is a workspace manifest for a multi-crate Rust project.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 4,404 stars.
  • Housekeeping100
    • .gitignore present.
Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot configured for cargo.
    Good: Issue or PR templates present.
  • examples
  • poem
  • poem-derive
  • poem-grpc
    Good: CONTRIBUTING guide or docs directory present.
  • poem-grpc-build
  • poem-lambda
  • poem-mcpserver
    Good: Test files detected (poem-mcpserver/tests).
  • poem-mcpserver-macros
  • poem-openapi
  • poem-openapi-derive
  • poem-worker
  • .gitignore
    Good: .gitignore present.
  • .rustfmt.toml
  • .tarpaulin.toml
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • favicon.ico
  • LICENSE-APACHE
  • LICENSE-MIT
  • logo.png
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Warning: 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.
    Info: 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.
    Warning: 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.
  • SECURITY.md
    Good: Security policy present.