oasdiff/oasdiff-action
Grade a repo

0

/ 100

GradeF

Some interest. A stronger README and CI would help.

GitHub Actions that detect breaking changes in your OpenAPI specs and post a review on every pull request

Documentation82
Engineering19
Health68
Shell61Apache-2.0today

Documentation

82

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

19

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

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.

Reproducibility6pt22

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

CI/CD14pt57

CI is configured (.github/workflows/test-breaking.yaml).

Project health

68

Dependency manifest6pt0

No dependency manifest detected at root.

→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

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)
  • 30
    Forks
  • 36
    Releaseslatest 3mo ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 61
    Watchers

Responsiveness

  • 13h
    Median issue response
  • 2h
    Median PR merge time
  • 1
    Open issues
Repository files12 root entries
  • .github
    Good: CI is configured (.github/workflows/test-breaking.yaml).
    Good: Dependabot configured for github-actions.
  • breaking
    Good: Environment pinned via breaking/Dockerfile.
  • changelog
  • diff
  • pr-comment
  • specs
  • validate
  • verify
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • LICENSE
    Good: Licensed under Apache-2.0.
  • 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.