c9s/bbgo

0

/ 100

Documentation94
Engineering88
Health100
Go1,657AGPL-3.01d ago
Grade a repo

A well-known project done right. Strong docs and solid engineering throughout.

The modern cryptocurrency trading bot framework written in Go.

Documentation

94

Contributing guide5pt78

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 AGPL-3.0.

Engineering

88

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.

Tests18pt100

Test files detected (charts/bbgo/templates/tests).

CI/CD14pt100

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

Linting and formatting5pt100

Formatting enforced (.golangci.yml).

Reproducibility6pt100

Lockfile present (go.sum). Installs are reproducible.

Project health

100

Dependency manifest6pt100

Dependency manifest found (go.mod).

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)
  • 375
    Forks
  • 123
    Releaseslatest 5y ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 1,657
    Watchers

Responsiveness

  • 9d 2h
    Median issue response
  • 2h
    Median PR merge time
  • 133
    Open issues
Repository files52 root entries
  • .claude
  • .github
    Good: CI is configured (.github/workflows/go.yml).
    Good: Dependabot covers 3 ecosystems (github-actions, gomod, npm). Dependencies stay current.
  • .junie
  • .vscode
  • apps
  • assets
  • charts
    Good: Test files detected (charts/bbgo/templates/tests).
  • cmd
  • config
  • contracts
  • data
  • desktop
  • doc
  • evans
  • examples
  • linode
  • migrations
  • pkg
  • prompts
  • scripts
  • testdata
  • utils
  • .aiignore
  • .dockerignore
  • .env.local.example
  • .evans.toml
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .golangci.yml
    Good: Formatting enforced (.golangci.yml).
  • .markdownlint.yaml
  • .nvmrc
  • .pre-commit-config.yaml
  • app.json
  • bbgo.sql
  • CLA.md
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • codecov.yaml
  • codecov.yml
  • CODEOWNERS
  • 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.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    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.
  • deploy.sh
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • go.mod
    Good: Dependency manifest found (go.mod).
  • go.sum
    Good: Lockfile present (go.sum). Installs are reproducible.
  • LICENSE
    Good: Licensed under AGPL-3.0.
  • Makefile
  • Procfile
  • README.md
    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.zh_TW.md
  • rockhopper_mysql.yaml
  • rockhopper_sqlite.yaml