cyan-2048/solid-telekram
Grade a repo

0

/ 100

GradeD

Getting some notice. Tests and CI would be the fastest wins.

Higher than 47% of 5,156 graded repos

Unofficial Telegram Client for KaiOS

Documentation78
Engineering45
Health83
TypeScript74GPL-3.01mo 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 (83).

See your top fixes
Now
D
63
Potential
B
83

Top fixes

Highest-impact changes first, ranked by point weight

19 to address
  1. 1
    Tests18pt

    Add a scripts.test entry and create your first test file.

  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 `pull_request:` to the workflow `on:` triggers.

  4. 4
    CI/CD14pt

    Add a lint step to catch style issues automatically.

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

78

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.

README12pt90

README is present.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under GPL-3.0.

Engineering

45

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.

Tests18pt40

A test framework is installed but no test script or test files were found.

→ Add a scripts.test entry and create your first test file.

CI/CD14pt40

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

Reproducibility6pt70

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

Linting and formatting5pt100

Linter or formatter configured (biome.json).

Project health

83

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt65

Dependency manifest found (package.json).

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

Community

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

Responsiveness

  • 15d 20h
    Median issue response
  • -
    Median PR merge time
  • 0
    Open issues
Repository files19 root entries
  • .github
    Good: CI is configured (.github/workflows/deploy.yml).
  • .vscode
  • @mtcute
  • public
  • screenshots
  • scripts
  • src
  • .env
    Issue: Build artifacts or local files may be committed (.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • .gitignore
    Good: .gitignore present.
  • biome.json
    Good: Linter or formatter configured (biome.json).
  • bun.lock
    Good: Lockfile present (bun.lock). Installs are reproducible.
  • FUNDING.yml
  • LICENSE
    Good: Licensed under GPL-3.0.
  • package.json
    Good: Dependency manifest found (package.json).
  • 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.
    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.
  • rsbuild.config.ts
  • tsconfig.app.json
  • tsconfig.json
  • tsconfig.node.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/cyan-2048/solid-telekram)](https://www.repo-grade.com/report/cyan-2048/solid-telekram)

More graded TypeScript repos