gothenburgbitfactory/taskchampion-sync-server

0

/ 100

Documentation83
Engineering73
Health100
Rust185MIT1d ago
Grade a repo

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

The sync server for Taskchampion

Documentation

83

README12pt70

README is present.

Contributing guide5pt80

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

73

Linting and formatting5pt0

No Rust linting or formatting enforced.

→ Add `cargo clippy -- -D warnings` and `cargo fmt --check` as CI steps, and optionally a rustfmt.toml for project-specific style rules.

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

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

Tests18pt100

Test files detected (sqlite/tests).

Reproducibility6pt100

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

Project health

100

Dependency manifest6pt100

Dependency manifest found (Cargo.toml).

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)
  • 28
    Forks
  • 8
    Releaseslatest 14d ago

Community

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

Responsiveness

  • 9h
    Median issue response
  • 3h
    Median PR merge time
  • 11
    Open issues
Repository files23 root entries
  • .github
    Good: CI is configured (.github/workflows/checks.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, cargo). Dependencies stay current.
  • core
  • docs
  • helm
  • postgres
  • server
  • sqlite
    Good: Test files detected (sqlite/tests).
  • .dockerignore
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Good: Contributing guide explains how to run tests.
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • docker-compose.yml
    Good: Environment pinned via docker-compose.yml.
  • Dockerfile-postgres
  • Dockerfile-sqlite
  • entrypoint-postgres.sh
  • entrypoint-sqlite.sh
  • LICENSE
    Good: Licensed under MIT.
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    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.
    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.
  • RELEASING.md
  • SECURITY.md
    Good: Security policy present.