theeconomist/the-economist-war-fire-model

0

/ 100

Documentation47
Engineering21
Health100
R276MIT1d ago
Grade a repo

Getting noticed, but rough fundamentals could turn visitors away.

Source code and data for The Economist's Ukraine war-fire model

Documentation

47

Install and run instructions9pt0

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

→ Add a section showing how to install dependencies.

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.

README12pt75

README is present.

License6pt100

Licensed under MIT.

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/pull_firms_via_https.yaml).

Reproducibility6pt80

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)
  • 30
    Forks
  • 2
    Releaseslatest 3y ago

Community

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

Responsiveness

  • 7h
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files13 root entries
  • .github
    Good: CI is configured (.github/workflows/pull_firms_via_https.yaml).
  • output-data
  • plots
  • scripts
  • source-data
  • .devcontainer.json
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • LICENCE
    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.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • requirements.txt
    Good: Lockfile present (requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (requirements.txt).
  • the-economist-war-fire-model.Rproj