0
/ 100
Strong community interest, but tests, CI, or docs need work.
OpenStack Networking (Neutron). Mirror of code maintained at opendev.org.
A low grade is a to-do list, not a judgment of your code
Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to B (85).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
- 2CI/CD14pt
If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
- 3README12pt
Expand with a description, install steps, usage, and examples.
- 4README12pt
Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
Working through the fixes? Let every push regrade itself.
The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
50
README is present.
No install instructions found in the README (−45 pts).
→ Add a section showing how to install dependencies.
CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.
→ Add setup instructions, code style notes, and how to run tests.
Licensed under Apache-2.0.
Engineering
52
No CI configuration detected in this repository.
→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
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.
Lockfile present (requirements.txt). Installs are reproducible.
Test files detected (neutron/common/test_lib.py).
Linter or formatter configured (.pylintrc).
Project health
100
Dependency manifest found (pyproject.toml).
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)
- 1,478Forks
- 0Releases
Community
- -Community health
- -authors own >50% of commits
- 1,464Watchers
Responsiveness
- -Median issue response
- -Median PR merge time
- 0Open issues
Repository files30 root entries
- api-ref
- devstack
- doc
- etc
- neutronGood: Test files detected (neutron/common/test_lib.py).
- playbooks
- rally-jobs
- releasenotes
- roles
- tools
- vagrant
- zuul.d
- .gitignoreGood: .gitignore present.
- .gitreview
- .mailmap
- .pre-commit-config.yaml
- .pylintrcGood: Linter or formatter configured (.pylintrc).
- .stestr.conf
- bindep.txt
- CONTRIBUTING.rstIssue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +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.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.Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
- HACKING.rst
- LICENSEGood: Licensed under Apache-2.0.
- pyproject.tomlGood: Dependency manifest found (pyproject.toml).
- README.rstGood: 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 little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown 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.Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.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.
- requirements.txtGood: Lockfile present (requirements.txt). Installs are reproducible.
- setup.cfg
- setup.py
- test-requirements.txt
- TESTING.rst
- tox.ini
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/openstack/neutron)