SeaQL/sea-ormNew scan
93/ 100 Β· A

A well-known project done right. Strong docs and solid engineering throughout.

🐚 A powerful relational ORM for Rust

Rust9,712 starsApache-2.0updated 3d ago
DocumentationREADME, setup, examples, license
96
EngineeringTests, CI, linting, lockfiles
89
Project healthDescription, activity, stars, deps
100

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
    CI/CD
    EngineeringInfo

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

  3. 3
    Install and run instructions
    DocumentationInfo

    Add a .env.example listing all required environment variables so contributors know what to set up.

Detailed breakdown

Documentation

96
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions90
    • README documents how to install the project.
    • 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 guide90
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide lacks a code style section (βˆ’8 pts).Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    • Contributing guide explains how to run tests.
    • Contributing guide describes the PR/review workflow.
    • Contributing guide includes code examples.
    • 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

89
  • Tests90
    • Test files detected (examples/actix_example/api/tests).
    • Cargo.toml has dev-dependencies and test files are present.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/rust.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.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting60
    • Linter or formatter configured (examples/loco_example/frontend/.eslintrc.cjs).
  • Reproducibility80
    • Lockfile present (examples/loco_example/Cargo.lock). Installs are reproducible.
    • Environment pinned via build-tools/docker-compose.yml.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
    • Cargo.toml does not specify edition 2021.Add `edition = "2021"` to [package] in Cargo.toml for the latest Rust language features.
  • Issue and PR templates90
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

100
  • Dependency manifest100
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml includes a description for crates.io.
    • Cargo.toml declares a license.
    • Cargo.toml links to the source repository.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: Rust.
    • Cargo.toml [package] metadata is complete (description, authors, repository).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 9,712 stars.
  • Housekeeping100
    • .gitignore present.
    • A .env file exists in a test directory (examples/actix_example/.env). This is a test fixture, not a committed secret.
Repository files30 root entries
  • .github
    Good: CI is configured (.github/workflows/rust.yml).
    Good: Issue or PR templates present.
  • build-tools
    Good: Environment pinned via build-tools/docker-compose.yml.
  • changelog
  • docs
  • examples
    Good: Test files detected (examples/actix_example/api/tests).
    Good: Linter or formatter configured (examples/loco_example/frontend/.eslintrc.cjs).
    Good: Lockfile present (examples/loco_example/Cargo.lock). Installs are reproducible.
  • issues
  • sea-orm-arrow
  • sea-orm-cli
  • sea-orm-codegen
  • sea-orm-macros
    Good: Licensed under Apache-2.0.
  • sea-orm-migration
  • sea-orm-rocket
  • sea-orm-sync
  • src
  • tests
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .rustfmt.toml
  • .taplo.toml
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CHANGELOG.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Info: Contributing guide lacks a code style section (βˆ’8 pts).Fix: Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • CLAUDE.md
  • COMMUNITY.md
  • CONTRIBUTING.md
  • DEVELOPMENT.md
  • LICENSE-APACHE
  • LICENSE-MIT
  • README-zh.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    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
  • VERSIONS.md