automattic/mongoose

0

/ 100

Documentation83
Engineering90
Health97
JavaScript27,480MIT6d ago
Grade a repo

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

MongoDB object modeling designed to work in an asynchronous environment.

Documentation

83

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt87

Contributing guide is detailed and thorough.

README12pt100

README is present.

License6pt100

Licensed under MIT.

Engineering

90

Reproducibility6pt20

No dependency lockfile found (−70 pts).

→ Commit package-lock.json, pnpm-lock.yaml, yarn.lock, or bun.lock so Node installs are repeatable.

Tests18pt100

Test files detected (.mocharc.yml).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (eslint.config.mjs).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

97

Dependency manifest6pt90

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files29 root entries
  • .github
    Good: CI is configured (.github/workflows/test.yml).
    Good: Dependabot covers 2 ecosystems (npm, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
  • benchmarks
  • docs
  • lib
  • scripts
  • test
  • tools
  • types
  • .gitignore
    Good: .gitignore present.
  • .markdownlint-cli2.cjs
  • .mocharc.yml
    Good: Test files detected (.mocharc.yml).
  • .npmignore
  • .npmrc
  • CHANGELOG.md
  • CNAME
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • eslint.config.mjs
    Good: Linter or formatter configured (eslint.config.mjs).
  • History.md
  • index.js
  • index.pug
  • lgtm.yml
  • LICENSE.md
    Good: Licensed under MIT.
  • migrating_to_5.md
  • package.json
    Good: Dependency manifest found (package.json).
  • 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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • release-items.md
  • SECURITY.md
    Good: Security policy present.
  • tsconfig.json
  • tstyche.json