linancn/tiangong-lca-next

0

/ 100

Documentation48
Engineering85
Health88
TypeScript22MIT1d ago
Grade a repo

Solid foundation. Invest in docs and CI to grow from here.

TianGong-LCA-NEXT

Documentation

48

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.

README12pt38

README is present.

Install and run instructions9pt55

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

85

Reproducibility6pt10

No dependency lockfile found (−70 pts).

→ Commit package-lock.json, pnpm-lock.yaml, yarn.lock, or bun.lock so Node installs are repeatable.

CI/CD14pt85

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

Tests18pt100

Test files detected (jest.config.cjs).

Linting and formatting5pt100

Linter or formatter configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

88

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt82

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)
  • 26
    Forks
  • 4
    Releaseslatest 5mo ago

Community

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

Responsiveness

  • <1h
    Median issue response
  • <1h
    Median PR merge time
  • 7
    Open issues
Repository files39 root entries
  • .docpact
  • .github
    Good: CI is configured (.github/workflows/build.yml).
    Good: Issue or PR templates present.
  • .husky
  • config
  • docker
    Good: Environment pinned via docker/docker-compose.yml.
  • docs
  • electron
  • icons
  • public
  • scripts
  • src
  • tests
  • types
  • .dockerignore
  • .editorconfig
    Good: Linter or formatter configured (.editorconfig).
  • .env
    Issue: Build artifacts or local files may be committed (.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • .env.development
  • .env.users.example
  • .eslintignore
  • .eslintrc.js
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .gitleaks.toml
  • .ncurc.json
  • .nvmrc
  • .prettierignore
  • .prettierrc.js
  • AGENTS.md
  • DEV.md
  • Dockerfile.app
  • electron-builder.json
  • jest.config.cjs
    Good: Test files detected (jest.config.cjs).
  • jsconfig.json
  • LICENSE
    Good: Licensed under MIT.
  • package.json
    Good: Dependency manifest found (package.json).
  • README_CN.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.
    Issue: README has some structure (−7 pts). 2-3 headings earns partial credit; 4+ earns the full +15 pts.Fix: Add more sections (Overview, Install, Usage, Contributing) using ## headings.
    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.
    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.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • README.md
  • tsconfig.electron.json
  • tsconfig.json