firelab/windninja

0

/ 100

Documentation67
Engineering23
Health68
C++168Other1d ago
Grade a repo

Getting noticed, but rough fundamentals could turn visitors away.

A diagnostic wind model developed for use in wildland fire modeling.

Documentation

67

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.

README12pt60

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

23

Tests18pt0

No tests detected anywhere in the repository.

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

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.

Reproducibility6pt10

No dependency lockfile found (−70 pts).

→ Commit the lockfile for this project's package manager so installs produce the same dependency versions everywhere.

CI/CD14pt40

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

Linting and formatting5pt100

Linter or formatter configured (data/leaflet/draw/.editorconfig).

Project health

68

Dependency manifest6pt0

No dependency manifest detected at root.

→ Add a manifest (package.json, pyproject.toml, Cargo.toml, go.mod, etc.) so others can install dependencies in one command.

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)
  • 55
    Forks
  • 34
    Releaseslatest 8y ago

Community

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

Responsiveness

  • 6d 10h
    Median issue response
  • 1d 8h
    Median PR merge time
  • 106
    Open issues
Repository files31 root entries
  • .builds
  • .github
    Good: CI is configured (.github/workflows/testing.yml).
  • autotest
  • cmake
  • data
    Good: Linter or formatter configured (data/leaflet/draw/.editorconfig).
  • doc
  • images
  • scripts
  • src
  • tools
  • .clang-format
  • .gitignore
    Good: .gitignore present.
  • .travis.yml
  • AUTHORS
  • CITATION
  • CMakeLists.txt
  • CONTRIBUTORS
  • CREDITS.md
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • Doxyfile
  • HOWTORELEASE
  • LICENSE
    Good: Licensed under Other.
  • LICENSE-3RD-PARTY
  • NEWS.md
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    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.
  • Singularity
  • vcpkg.json
  • VERSION
  • vg.sup
  • wn-ms-resource.rc
  • wn-resources.qrc