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

Tools repository leveraged by the Azure SDK team.

Documentation

61

Install and run instructions9pt10

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

Add a section showing how to install dependencies.

Contributing guide5pt66

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

Add setup instructions, code style notes, and how to run tests.

README12pt78

README is present.

License6pt100

Licensed under MIT.

Engineering

76

Tests18pt35

Test files detected (eng/common-tests/apiview-markdown/tests).

CI/CD14pt100

CI is configured (.github/workflows/test-login-to-github.yml).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Reproducibility6pt100

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

Issue and PR templates6pt100

Issue or PR templates present.

Project health

86

Dependency manifest6pt55

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)
  • 244
    Forks
  • 1000
    Releaseslatest 3y ago

Community

  • Community health
  • authors own >50% of commits
  • 132
    Watchers

Responsiveness

  • 15d
    Median issue response
  • 1h
    Median PR merge time
  • 2,008
    Open issues
Repository files25 root entries
  • .config
  • .devcontainer
  • .github
    Good: CI is configured (.github/workflows/test-login-to-github.yml).
    Good: Dependabot covers 4 ecosystems (npm, npm, npm, github-actions). Dependencies stay current.
    Good: Issue or PR templates present.
    Good: .gitignore present.
  • .vscode
  • doc
  • eng
    Good: Test files detected (eng/common-tests/apiview-markdown/tests).
  • packages
  • plugins
  • src
  • tools
    Good: Environment pinned via tools/http-fault-injector/Dockerfile.
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .gitattributes
  • .gitignore
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    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.
    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.
  • Directory.Build.props
  • Directory.Build.targets
  • global.json
  • LICENSE
    Good: Licensed under MIT.
  • mgmtci.proj
  • NOTICE.txt
  • NuGet.Config
  • 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 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.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • SECURITY.md
    Good: Security policy present.