twirapp/twir
Grade a repo

0

/ 100

GradeD

Popular for its size, but the engineering basics lag behind the interest.

Higher than 49% of 5,156 graded repos

Twitch chat bot written on Golang and TypeScript.

Documentation73
Engineering53
Health83
Go215Other1mo ago

A low grade is a to-do list, not a judgment of your code

Most gaps here are documentation, tests, and setup, not the code itself. Closing your top 3 gaps alone would lift this repo to B (85).

See your top fixes
Now
D
65
Potential
B
85

Top fixes

Highest-impact changes first, ranked by point weight

15 to address
  1. 1
    Tests18pt

    Set scripts.test in package.json to your actual test command, e.g. "vitest" or "jest".

  2. 2
    CI/CD14pt

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  3. 3
    CI/CD14pt

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

  4. 4
    CI/CD14pt

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

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

73

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.

README12pt70

README is present.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

Licensed under Other.

Engineering

53

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.

Tests18pt35

Test files detected (apps/api-gql/internal/delivery/gql/resolvers/twir_events_test.go).

CI/CD14pt72

CI is configured (.github/workflows/build-and-lint.yml).

Reproducibility6pt80

Lockfile present (bun.lock). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Project health

83

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt65

Dependency manifest found (go.work).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 16
    Forks
  • 43
    Releaseslatest 2mo ago

Community

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

Responsiveness

  • 16h
    Median issue response
  • <1h
    Median PR merge time
  • 65
    Open issues
Repository files53 root entries
  • .agents
    Good: Security policy present.
  • .codegraph
    Good: .gitignore present.
  • .github
    Good: CI is configured (.github/workflows/build-and-lint.yml).
  • .idea
    Issue: Build artifacts or local files may be committed (.idea/OxcSettings.xml) (−40 pts).Fix: Remove them and add to .gitignore.
  • .omo
  • .opencode
  • .run
  • .sisyphus
  • .vscode
  • .zed
  • apps
    Good: Test files detected (apps/api-gql/internal/delivery/gql/resolvers/twir_events_test.go).
    Good: Environment pinned via apps/api-gql/Dockerfile.
  • cli
  • configs
  • deploy
  • docs
  • frontend
  • libs
  • web
  • .augment-guidelines
  • .bun-version
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .env.example
  • .env.mock.example
  • .gitignore
  • .golangci.yml
  • .graphqlrc.yml
  • .npmrc
  • .oxfmtrc.jsonc
  • .oxlintrc.json
  • AGENTS.md
  • bun.lock
    Good: Lockfile present (bun.lock). Installs are reproducible.
  • bunfig.toml
  • Caddyfile.dev
  • clickhouse-backup.yaml
  • cliff.toml
  • crowdin.yml
  • docker-compose.dev.yml
  • docker-compose.observability.yml
  • docker-compose.stack.yml
  • docker-entrypoint.sh
  • go.work
    Good: Dependency manifest found (go.work).
  • go.work.sum
  • kuber.md
  • LICENSE
    Good: Licensed under Other.
  • MOCK_API.md
  • OBSERVABILITY.md
  • package.json
  • postgres-language-server.jsonc
  • PRODUCTION.md
  • 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.
  • skills-lock.json
  • tsconfig.base.json
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/twirapp/twir)](https://www.repo-grade.com/report/twirapp/twir)

More graded Go repos