mtiller/modelicabook
Grade a repo

0

/ 100

GradeF

Popular for its size, but the engineering basics lag behind the interest.

Source for my new Modelica Book

Documentation74
Engineering21
Health100
JavaScript116Othertoday

Documentation

74

Contributing guide5pt25

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.

README12pt70

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

21

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

Linting and formatting5pt0

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.

Issue and PR templates6pt0

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/CD14pt40

CI is configured (.github/workflows/build.yaml).

Reproducibility6pt80

Lockfile present (api/yarn.lock). Installs are reproducible.

Project health

100

Dependency manifest6pt100

Dependency manifest found (api/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)
  • 72
    Forks
  • 0
    Releases

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 116
    Watchers

Responsiveness

  • 23d 12h
    Median issue response
  • 1d 2h
    Median PR merge time
  • 62
    Open issues
Repository files32 root entries
  • .devcontainer
    Good: Environment pinned via .devcontainer/Dockerfile.
  • .dvc
    Good: .gitignore present.
  • .github
    Good: CI is configured (.github/workflows/build.yaml).
  • .vscode
  • api
    Good: 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.md
    Good: Licensed under Other.
  • Makefile
  • nextgen
  • NOTES
  • outline.yml
  • README.md
    Good: 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