azure/openapi-diff

0

/ 100

Documentation61
Engineering87
Health94
C#288MIT1d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

Command line tool to detect breaking changes between two openapi specifications

Documentation

61

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

README12pt48

README is present.

Contributing guide5pt76

Contributing guide is detailed and thorough.

License6pt100

Licensed under MIT.

Engineering

87

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.

Reproducibility6pt90

Lockfile present (package-lock.json). Installs are reproducible.

Tests18pt100

Test files detected (openapi-diff/src/modeler/AutoRest.Swagger.Tests/SwaggerModelerCompareTests.cs).

CI/CD14pt100

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

Linting and formatting5pt100

Linter or formatter configured (.prettierrc).

Project health

94

Dependency manifest6pt82

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)
  • 44
    Forks
  • 8
    Releaseslatest 7y ago

Community

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

Responsiveness

  • 15d 1h
    Median issue response
  • 1h
    Median PR merge time
  • 97
    Open issues
Repository files22 root entries
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, npm). Dependencies stay current.
  • .vscode
  • docs
  • eng
  • openapi-diff
    Good: Test files detected (openapi-diff/src/modeler/AutoRest.Swagger.Tests/SwaggerModelerCompareTests.cs).
  • src
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .markdownlint.jsonc
  • .prettierignore
  • .prettierrc
    Good: Linter or formatter configured (.prettierrc).
  • azure-pipelines.yml
  • CHANGELOG.md
  • 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.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Good: Contributing guide includes code examples.
  • CredScanSuppressions.json
  • eslint.config.js
  • LICENSE
    Good: Licensed under MIT.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    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.
    Issue: 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.
    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.
  • SECURITY.md
    Good: Security policy present.
  • tsconfig.json