0
/ 100
Popular for its size, but the engineering basics lag behind the interest.
Source for my new Modelica Book
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 (83).
See your top fixesTop fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Add automated tests. They prove the code works and give contributors confidence to make changes.
- 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
74
Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).
→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.
README is present.
README documents how to install the project.
Licensed under Other.
Engineering
21
No tests detected anywhere in the repository.
→ Add automated tests. They prove the code works and give contributors confidence to make changes.
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.
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/build.yaml).
Lockfile present (api/yarn.lock). Installs are reproducible.
Project health
100
Dependency manifest found (api/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)
- 72Forks
- 0Releases
Community
- -Community health
- -authors own >50% of commits
- 116Watchers
Responsiveness
- 23d 12hMedian issue response
- 1d 2hMedian PR merge time
- 62Open issues
Repository files32 root entries
- .devcontainerGood: Environment pinned via .devcontainer/Dockerfile.
- .dvcGood: .gitignore present.
- .githubGood: CI is configured (.github/workflows/build.yaml).
- .vscode
- apiGood: Lockfile present (api/yarn.lock). Installs are reproducible.Good: Dependency manifest found (api/package.json).
- docker
- images
- misc
- ModelicaByExample
- org
- retired
- sponsors
- text
- tools
- .dvcignore
- .gitignore
- .gitlab-ci.old
- .gitmodules
- .kvenv
- apps
- ARCHITECTURE.md
- BUILD.md
- CHANGELOG.md
- dvc.lock
- generator
- LICENSE.mdGood: Licensed under Other.
- Makefile
- nextgen
- NOTES
- outline.yml
- README.mdGood: README is present.Good: README is well structured with multiple sections.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.Good: README has code examples.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.Good: README documents how to install the project.Good: README documents how to run the project.
- TRANSLATION.md
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/mtiller/modelicabook)