73
/ 100
Good shape overall. A few tweaks would push it into the top tier.
GitHub read-only mirror of ns-3-dev repository, will be kept in sync with main GitLab.com repository. Please DO NOT file pull requests here; instead, file issues and merge requests at https://gitlab.com/nsnam/ns-3-dev/
Top 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
Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
- 3CI/CD14pt
Add `pull_request:` to the workflow `on:` triggers.
- 4CI/CD14pt
Add a lint step to catch style issues automatically.
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
92
Contributing guide is detailed and thorough.
README documents how to install the project.
README is present.
Licensed under Other.
Engineering
51
No dependency lockfile found (−70 pts).
→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.
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.
CI is configured (.github/workflows/per_commit.yml).
Test files detected (src/antenna/test).
Linter or formatter configured (.editorconfig).
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
- 35 / 105Commits (30d / 90d)
- 666Forks
- 0Releases
Community
- 62% - FairCommunity health
- 3 bus factorauthors own >50% of commits
- 549Watchers
Responsiveness
- -Median issue response
- -Median PR merge time
- 0Open issues
Repository files39 root entries
- .githubGood: CI is configured (.github/workflows/per_commit.yml).
- .vscode
- bindings
- build-support
- contrib
- doc
- examples
- LICENSES
- scratch
- srcGood: Test files detected (src/antenna/test).
- third-party
- utils
- .clang-format
- .clang-tidy
- .codespellrc
- .editorconfigGood: Linter or formatter configured (.editorconfig).
- .gitattributes
- .gitignoreGood: .gitignore present.
- .mailmap
- .markdownlint.yml
- .ns3.supp
- AGENTS.md
- AUTHORS
- CHANGES.md
- CLAUDE.md
- CMakeLists.txt
- CMakePresets.json.in
- CODE_OF_CONDUCT.mdGood: Code of conduct present.
- CONTRIBUTING.mdGood: Contributing guide is detailed and thorough.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.
- LICENSEGood: Licensed under Other.
- ns3
- pyproject.tomlGood: Dependency manifest found (pyproject.toml).
- README.mdGood: 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.
- RELEASE_NOTES.md
- setup.cfg
- setup.py
- test.py
- utils.py
- VERSION
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/nsnam/ns-3-dev-git)