open-reaction-database/ord-schemaNew scan
95/ 100 · A

Polished and well engineered. Punching above its star count.

Schema for the Open Reaction Database

JavaScript110 starsApache-2.0updated 2d ago

Outstanding work. A score of 95/100 puts this repo in a very small tier of truly well-engineered open source projects.

DocumentationREADME, setup, examples, license
97
EngineeringTests, CI, linting, lockfiles
92
Project healthDescription, activity, stars, deps
98

What to fix first

The highest-impact improvements for this repo.

  1. 1
    Tests
    EngineeringIssue

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    Install and run instructions
    DocumentationIssue

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

  3. 3
    Reproducibility
    EngineeringIssue

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

Detailed breakdown

Documentation

97
  • 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.
    • No .env.example found (−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 guide100
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide describes code style expectations.
    • 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.A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

92
  • Tests85
    • Test files detected (js/ord-schema/proto/dataset_pb.test.js).
    • Pytest referenced in pyproject.toml and test files present.
    • Test files detected (85/100) but no test runner configured (−15 pts). Without a documented test command the suite cannot be verified by contributors.Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
  • CI/CD100

    Not applicable?

    • CI is configured (.github/workflows/run_tests.yml).
    • CI workflow runs tests.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • CI runs type checking (tsc, mypy, cargo check, etc.).
    • CI reports or uploads test coverage.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting100
    • Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).
  • Reproducibility80
    • Lockfile present (uv.lock). Installs are reproducible.
    • Environment pinned via .python-version.
    • 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.
  • Issue and PR templates100
    • 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

98
  • Dependency manifest93
    • Dependency manifest found (pyproject.toml).
    • pyproject.toml has a [project] table with package metadata.
    • pyproject.toml includes a description.
    • pyproject.toml specifies requires-python, preventing installs on incompatible versions.
    • pyproject.toml lists no authors (−7 pts).Add `authors = [...]` under [project] so the package has clear ownership.
    • pyproject.toml has a [build-system] table. The package can be built and published.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: JavaScript.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 110 stars.
  • Housekeeping100
    • .gitignore present.
Repository files25 root entries
  • .github
    Good: CI is configured (.github/workflows/run_tests.yml).
    Good: Issue or PR templates present.
  • actions
  • docs
  • examples
  • js
    Good: Test files detected (js/ord-schema/proto/dataset_pb.test.js).
  • logos
  • ord_schema
  • proto
  • .bumpversion.cfg
  • .clang-format
  • .coveragerc
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .python-version
    Good: Environment pinned via .python-version.
  • .readthedocs.yml
  • AUTHORS
  • compile_proto_wrappers.sh
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Good: Contributing guide describes code style expectations.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • MANIFEST.in
  • postBuild
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README.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.
  • uv.lock
    Good: Lockfile present (uv.lock). Installs are reproducible.