clan-lol/clan-core

0

/ 100

Documentation76
Engineering61
Health100
Python166MIT1d ago
Grade a repo

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

Build your own clan [read-only mirror of https://git.clan.lol/clan/clan-core]

Documentation

76

README12pt55

README is present.

Contributing guide5pt72

CONTRIBUTING guide found.

Install and run instructions9pt90

README documents how to install the project.

License6pt100

Licensed under MIT.

Engineering

61

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/repo-sync.yml).

Tests18pt80

Test files detected (clanServices/admin/tests).

Reproducibility6pt82

Lockfile present (pkgs/clan-app/ui/package-lock.json). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (pkgs/clan-app/ui/eslint.config.ts).

Project health

100

Dependency manifest6pt100

Dependency manifest found (pyproject.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)
  • 16
    Forks
  • 0
    Releases

Community

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

Responsiveness

  • —
    Median issue response
  • <1h
    Median PR merge time
  • 1
    Open issues
Repository files32 root entries
  • .gitea
  • .github
    Good: CI is configured (.github/workflows/repo-sync.yml).
    Good: Dependabot configured for github-actions.
  • checks
  • clanServices
    Good: Test files detected (clanServices/admin/tests).
  • darwinModules
  • devFlake
  • docs
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
  • flakeModules
  • lib
  • machines
  • modules
  • nixosModules
  • pkgs
    Good: Linter or formatter configured (pkgs/clan-app/ui/eslint.config.ts).
    Good: Lockfile present (pkgs/clan-app/ui/package-lock.json). Installs are reproducible.
  • scripts
  • sops
  • templates
  • vars
  • _typos.toml
  • .envrc
  • .gitignore
    Good: .gitignore present.
  • .rumdl.toml
  • apps.nix
  • CODEOWNERS
  • devShell.nix
  • flake.lock
  • flake.nix
  • formatter.nix
  • inventory.json
  • LICENSE.md
    Good: Licensed under MIT.
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • 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.
    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.
    Good: README documents how to run the project.
  • VERSION