opral/flashtype

0

/ 100

Documentation64
Engineering80
Health89
TypeScript215MIT1d ago
Grade a repo

Good shape overall. A few tweaks would push it into the top tier.

The markdown editor for Claude & Codex

Documentation

64

Install and run instructions9pt45

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

Contributing guide5pt53

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.

README12pt65

README is present.

License6pt100

Licensed under MIT.

Engineering

80

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.

Reproducibility6pt70

Lockfile present (pnpm-lock.yaml). Installs are reproducible.

CI/CD14pt85

CI is configured (.github/workflows/continuous-integration.yml).

Tests18pt100

Test files detected (e2e/files-click-tour.spec.ts).

Linting and formatting5pt100

Linter or formatter configured (.prettierrc.json).

Project health

89

Dependency manifest6pt65

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)
  • 19
    Forks
  • 6
    Releaseslatest 4d ago

Community

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

Responsiveness

  • 15h
    Median issue response
  • <1h
    Median PR merge time
  • 21
    Open issues
Repository files38 root entries
  • .agents
  • .cargo
  • .changenotes
  • .github
    Good: CI is configured (.github/workflows/continuous-integration.yml).
  • .vscode
  • assets
  • build
  • e2e
    Good: Test files detected (e2e/files-click-tour.spec.ts).
  • electron
  • public
  • scripts
  • src
  • submodule
  • website
  • .gitignore
    Good: .gitignore present.
  • .gitmodules
  • .infisical.json
  • .oxlintrc.json
  • .prettierrc.json
    Good: Linter or formatter configured (.prettierrc.json).
  • CHANGELOG.md
  • components.json
  • 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.
    Issue: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    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).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • electron-builder.yml
  • index.html
  • LICENSE
    Good: Licensed under MIT.
  • package.json
    Good: Dependency manifest found (package.json).
  • plan.md
  • playwright.config.ts
  • playwright.packaged.config.ts
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    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.
    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.
    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.
  • rust-toolchain.toml
  • setup-tests.ts
  • tsconfig.json
  • vite.config.ts
  • vitest.config.ts
  • wrangler.json