ssnangua/colortxt

0

/ 100

Documentation63
Engineering31
Health94
TypeScript429MPL-2.01d ago
Grade a repo

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

「彩读 2.0 AI+」——一款会给内容上色的本地 TXT 小说阅读器，带给你不一样的阅读体验！（也支持打开常见的电子书格式，如 .epub）。还有章节识别、简繁互转、划线标注、记笔记、多角色语音朗读、AI 阅读助手、AI 智能排版等功能。支持 macOS、Windows 和 Linux。

Documentation

63

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.

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 MPL-2.0.

Engineering

31

Tests18pt0

No tests detected anywhere in the repository.

→ Add automated tests. They prove the code works and give contributors confidence to make changes.

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.

CI/CD14pt40

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

Reproducibility6pt80

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

Linting and formatting5pt100

Linter or formatter configured (lint script in package.json).

Project health

94

Dependency manifest6pt82

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)
  • 26
    Forks
  • 12
    Releaseslatest 9d ago

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 429
    Watchers

Responsiveness

  • 5h
    Median issue response
  • —
    Median PR merge time
  • 4
    Open issues
Repository files17 root entries
  • .github
    Good: CI is configured (.github/workflows/release.yml).
  • images
  • resources
  • scripts
  • src
  • .gitignore
    Good: .gitignore present.
  • .node-version
    Good: Environment pinned via .node-version.
  • CHANGELOG.md
  • DOCS.md
  • electron.vite.config.ts
  • IMAGES.md
  • LICENSE
    Good: Licensed under MPL-2.0.
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • 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.
    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.
  • tsconfig.json
  • vite.config.ts