echostack-org/echopype
Grade a repo

0

/ 100

GradeB

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

Top 26% of 5,156 graded repos

Enabling interoperability and scalability in ocean sonar data analysis

Documentation67
Engineering86
Health100
Python138Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

9 to address
  1. 1
    CI/CD14pt

    Add a lint step to catch style issues automatically.

  2. 2
    CI/CD14pt

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    README12pt

    Show a quick-start snippet so contributors can see what using your project looks like.

  4. 4
    Install and run instructions9pt

    Add a section showing how to install dependencies.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

67

Contributing guide5pt25

Contributing guidance is in the README, not a dedicated CONTRIBUTING.md (−20 pts).

→ Moving it to a CONTRIBUTING.md makes it easier to find and keeps the README focused. A dedicated file earns +47 pts base.

Install and run instructions9pt45

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

→ Add a section showing how to install dependencies.

README12pt85

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

86

Reproducibility6pt22

No dependency lockfile found (−70 pts).

→ Commit poetry.lock, uv.lock, pdm.lock, Pipfile.lock, conda-lock.yml, or another lockfile for your Python dependency manager.

CI/CD14pt85

CI is configured (.github/workflows/build.yaml).

Tests18pt100

Test files detected (echopype/tests).

Linting and formatting5pt100

Linter or formatter configured ([tool.ruff] / [tool.black] in pyproject.toml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (pyproject.toml).

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)
  • 91
    Forks
  • 36
    Releaseslatest 5y ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 138
    Watchers

Responsiveness

  • 37d 22h
    Median issue response
  • <1h
    Median PR merge time
  • 115
    Open issues
Repository files14 root entries
  • .ci_helpers
    Good: Environment pinned via .ci_helpers/docker/docker-compose.yaml.
  • .github
    Good: CI is configured (.github/workflows/build.yaml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • docs
  • echopype
    Good: Test files detected (echopype/tests).
  • .coveragerc
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • .readthedocs.yml
  • CITATION.cff
  • gsoc_contrib_guide.md
  • LICENSE
    Good: Licensed under Apache-2.0.
  • MANIFEST.in
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • 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.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/echostack-org/echopype)](https://www.repo-grade.com/report/echostack-org/echopype)

More graded Python repos