kaoruha/ginkgo
Grade a repo

0

/ 100

GradeB

Solid foundation. Invest in docs and CI to grow from here.

Top 26% of 5,156 graded repos

Python Backtesting library for trading research

Documentation77
Engineering81
Health100
Python14MIT1mo ago

Top fixes

Highest-impact changes first, ranked by point weight

10 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
    CI/CD14pt

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

  4. 4
    README12pt

    Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.

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

77

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.

README12pt70

README is present.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

81

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.

Reproducibility6pt80

Lockfile present (package-lock.json). Installs are reproducible.

CI/CD14pt85

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

Tests18pt100

Test files detected (api/scripts/test_sse.py).

Linting and formatting5pt100

Linter or formatter configured (web-ui/.eslintrc.cjs).

Project health

100

Dependency manifest6pt100

Dependency manifest found (package.json).

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)
  • 7
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • 2d 11h
    Median issue response
  • <1h
    Median PR merge time
  • 896
    Open issues
Repository files46 root entries
  • .claude
  • .conf
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
  • .specify
  • api
    Good: Test files detected (api/scripts/test_sse.py).
  • docs
  • examples
  • features
  • mcp_server
  • migrations
  • research
  • scripts
  • specs
  • src
  • tests
  • web-ui
    Good: Linter or formatter configured (web-ui/.eslintrc.cjs).
  • .dockerignore
  • .env.example
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • AGENTS.md
  • backup.sh
  • CHANGELOG.md
  • CLAUDE.md
  • CONTEXT.md
  • coverage.json
  • deploy-test.cjs
  • docker-compose.yml
    Good: Environment pinned via docker-compose.yml.
  • install.py
  • LICENSE
    Good: Licensed under MIT.
  • main.py
  • node
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • pnpm-lock.yaml
  • pyproject.toml
  • pytest.e2e.ini
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Good: README has code examples.
    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.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • restore.sh
  • setup_install.py
  • setup.py
  • show-logs.sh
  • test_memory_profile.md
  • test_report.md
  • uninstall.sh
  • uv.lock
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/kaoruha/ginkgo)](https://www.repo-grade.com/report/kaoruha/ginkgo)

More graded Python repos