filcdev/filc

0

/ 100

Documentation22
Engineering36
Health83
TypeScript8AGPL-3.03d ago
Grade a repo

Lots of room to improve. Start with a README and CI.

The core of the Filc application stack, chronos and iris

Documentation

22

README12pt0

README is present.

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 instructions9pt10

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

→ Add a section showing how to install dependencies.

License6pt100

Licensed under AGPL-3.0.

Engineering

36

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/CD14pt57

CI is configured (.github/workflows/check.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 (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)
  • 1
    Forks
  • 0
    Releases

Community

  • 37% - Weak
    Community health
  • 1 bus factorlow
    author own >50% of commits
  • 8
    Watchers

Responsiveness

  • 4d 1h
    Median issue response
  • <1h
    Median PR merge time
  • 11
    Open issues
Repository files17 root entries
  • .devcontainer
    Good: Environment pinned via .devcontainer/Dockerfile.
  • .github
    Good: CI is configured (.github/workflows/check.yml).
  • .husky
  • .vscode
  • apps
  • .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.
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • biome.jsonc
  • bun.lock
    Good: Lockfile present (bun.lock). Installs are reproducible.
  • bunfig.toml
  • LICENSE
    Good: Licensed under AGPL-3.0.
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Issue: README is very short (−20 pts). 400+ characters earns +10 pts; 1,500+ earns +20 pts.Fix: Add an Overview, Install, Usage, and Contributing section at minimum.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown 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.
    Issue: No live demo link in the README (−20 pts).Fix: Link to a deployed version, docs site, or demo video. Users want to see it running.
    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.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • turbo.json