Good shape overall. A few tweaks would push it into the top tier.
Tools repository leveraged by the Azure SDK team.
Documentation
61
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
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.
README is present.
Licensed under MIT.
Engineering
76
Test files detected (eng/common-tests/apiview-markdown/tests).
CI is configured (.github/workflows/test-login-to-github.yml).
Linter or formatter configured (.editorconfig).
Lockfile present (package-lock.json). Installs are reproducible.
Issue or PR templates present.
Project health
86
Dependency manifest found (package.json).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- —Commits (30d / 90d)
- 244Forks
- 1000Releaseslatest 3y ago
Community
- 75% - GoodCommunity health
- —authors own >50% of commits
- 132Watchers
Responsiveness
- 15dMedian issue response
- 1hMedian PR merge time
- 2,009Open issues
Repository files25 root entries
- .config
- .devcontainer
- .githubGood: 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
- engGood: Test files detected (eng/common-tests/apiview-markdown/tests).
- packages
- plugins
- src
- toolsGood: Environment pinned via tools/http-fault-injector/Dockerfile.
- .editorconfigGood: Linter or formatter configured (.editorconfig).
- .gitattributes
- .gitignore
- CONTRIBUTING.mdIssue: 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
- LICENSEGood: Licensed under MIT.
- mgmtci.proj
- NOTICE.txt
- NuGet.Config
- package-lock.jsonGood: Lockfile present (package-lock.json). Installs are reproducible.
- package.jsonGood: Dependency manifest found (package.json).
- README.mdGood: 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.mdGood: Security policy present.