quokka-astro/quokka

0

/ 100

Documentation83
Engineering70
Health100
C++80MIT1d ago
Grade a repo

Solid foundation. Invest in docs and CI to grow from here.

Two-moment AMR radiation hydrodynamics (with self-gravity, particles, chemistry, and magnetic fields) on CPUs/GPUs for astrophysics

Documentation

83

Contributing guide5pt47

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.

README12pt85

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

70

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.

CI/CD14pt57

CI is configured (.github/workflows/check_changes.yml).

Tests18pt80

Test files detected (docs/markdown/tests).

Reproducibility6pt100

Lockfile present (.github/workflows/dependencies/requirements.txt). Installs are reproducible.

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (.github/workflows/dependencies/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)
  • 24
    Forks
  • 6
    Releaseslatest 1mo ago

Community

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

Responsiveness

  • 16d 9h
    Median issue response
  • 2h
    Median PR merge time
  • 203
    Open issues
Repository files29 root entries
  • .ci
  • .claude
  • .devcontainer
    Good: Environment pinned via .devcontainer/cuda-azp-agent-in-docker/Dockerfile.
  • .github
    Good: CI is configured (.github/workflows/check_changes.yml).
    Good: Lockfile present (.github/workflows/dependencies/requirements.txt). Installs are reproducible.
    Good: Dependabot covers 5 ecosystems (gitsubmodule, github-actions, pip, pip, pip). Dependencies stay current.
    Good: Issue or PR templates present.
    Good: Dependency manifest found (.github/workflows/dependencies/requirements.txt).
  • docs
    Good: Test files detected (docs/markdown/tests).
  • extern
  • inputs
  • paper
  • regression
  • scripts
  • src
  • tests
  • .codespell-ignore-words
  • .codespellrc
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .mailmap
  • .pre-commit-config.yaml
  • AGENTS.md
  • CITATION.cff
  • CLAUDE.md
  • CMakeLists.txt
  • context7.json
  • CONTRIBUTING.md
    Issue: 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.
  • LICENSE
    Good: Licensed under MIT.
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    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.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • run-codeql.sh
  • sonar-project.properties