open-aims/julia_pinn_training_2026

0

/ 100

Documentation55
Engineering20
Health100
Julia6MIT1d ago
Grade a repo

Fresh project. Add a README and CI early.

Material for the training workshop on Physics-informed Neural Networks with Julialang

Documentation

55

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

Install and run instructions9pt45

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

README12pt63

README is present.

License6pt100

Licensed under MIT.

Engineering

20

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_course.yaml).

Reproducibility6pt70

Lockfile present (requirements.txt). Installs are reproducible.

Project health

100

Dependency manifest6pt100

Dependency manifest found (requirements.txt).

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)
  • 2
    Forks
  • 2
    Releaseslatest 1mo ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 6
    Watchers

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files19 root entries
  • _freeze
  • .github
    Good: CI is configured (.github/workflows/build_course.yaml).
  • images
  • units
  • _quarto.yml
  • .gitignore
    Good: .gitignore present.
  • build.sh
  • CODE_REVIEW_2026-06-21.md
  • index.qmd
  • LICENSE
    Good: Licensed under MIT.
  • Makefile
  • Project.toml
  • PROOFREAD_2026-06-21.md
  • README.md
    Good: 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.
    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.
    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.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (requirements.txt).
  • REVIEW_NOTES_2026-06-13.md
  • SETUP.md
  • styles.scss
  • toc-date.html