swiftsim/swift

0

/ 100

Documentation93
Engineering58
Health68
C156LGPL-3.01d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

Modern astrophysics and cosmology particle-based code. Mirror of gitlab developments at https://gitlab.cosma.dur.ac.uk/swift/swiftsim

Documentation

93

Contributing guide5pt74

Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under LGPL-3.0.

Engineering

58

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.

Reproducibility6pt0

No dependency lockfile found (−70 pts).

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

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.

Tests18pt80

Test files detected (examples/Cooling/CoolingHalo/test_energy_conservation.py).

CI/CD14pt100

CI is configured (.gitlab-ci.yml).

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

Community

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

Responsiveness

  • 3h
    Median issue response
  • 17h
    Median PR merge time
  • 17
    Open issues
Repository files33 root entries
  • argparse
    Good: Licensed under LGPL-3.0.
  • ci
  • doc
  • examples
    Good: Test files detected (examples/Cooling/CoolingHalo/test_energy_conservation.py).
  • m4
  • src
  • tests
  • theory
  • tools
  • .clang-format
  • .gitignore
    Good: .gitignore present.
  • .gitlab-ci.yml
    Good: CI is configured (.gitlab-ci.yml).
  • .gitmodules
  • AUTHORS
  • autogen.sh
  • ChangeLog
  • CITATION.cff
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • configure.ac
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (−6 pts). 400+ words earns the full +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.
    Good: Contributing guide describes code style expectations.
    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).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • COPYING
  • COPYING.LESSER
  • csds
  • format_python.sh
  • format.sh
  • INSTALL.swift
  • Makefile.am
  • NEWS
  • README
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    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.
  • README-mpi-hints.md
  • README.md
  • swift_fof.c
  • swift.c