andersen-lab/freyja

0

/ 100

Documentation79
Engineering79
Health100
HTML134BSD-2-Clause1d ago
Grade a repo

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

Depth-weighted De-Mixing

Documentation

79

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 instructions9pt90

README documents how to install the project.

README12pt93

README is present.

License6pt100

Licensed under BSD-2-Clause.

Engineering

79

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.

Reproducibility6pt70

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

Tests18pt80

Test files detected (freyja/tests).

CI/CD14pt100

CI is configured (.github/workflows/python-package-conda.yml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (setup.py).

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)
  • 36
    Forks
  • 34
    Releaseslatest 4y ago

Community

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

Responsiveness

  • 3h
    Median issue response
  • <1h
    Median PR merge time
  • 2
    Open issues
Repository files11 root entries
  • .github
    Good: CI is configured (.github/workflows/python-package-conda.yml).
    Good: Issue or PR templates present.
  • ci
  • docs
    Good: Lockfile present (docs/requirements.txt). Installs are reproducible.
  • freyja
    Good: Test files detected (freyja/tests).
  • freyja.egg-info
  • .gitignore
    Good: .gitignore present.
  • CHANGELOG.rst
  • LICENSE
    Good: Licensed under BSD-2-Clause.
  • Makefile
  • 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.
    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.
  • setup.py
    Good: Dependency manifest found (setup.py).