A top-tier open source project. Docs, tests, and CI are all in excellent shape.

♞ lichess.org: the forever free, adless and open source chess server ♞

Documentation

92

Contributing guide5pt67

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under AGPL-3.0.

Engineering

87

CI/CD14pt57

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

Reproducibility6pt92

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

Tests18pt100

Test files detected (modules/analyse/src/test).

Linting and formatting5pt100

Linter or formatter configured (.stylelintrc.json).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

86

Dependency manifest6pt55

Dependency manifest found (package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files42 root entries
  • .github
    Good: CI is configured (.github/workflows/lint.yml).
    Good: Dependabot configured for github-actions.
    Good: Issue or PR templates present.
  • app
  • bin
  • conf
  • cron
  • modules
    Good: Test files detected (modules/analyse/src/test).
  • project
  • public
  • scripts
  • tests
  • translation
  • ui
  • .git-blame-ignore-revs
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • .ignore
  • .lfsconfig
  • .node-version
    Good: Environment pinned via .node-version.
  • .oxfmtrc.json
  • .oxlintrc.json
  • .sbtopts.default
  • .scala-steward.conf
  • .scalafix.conf
  • .scalafmt.conf
  • .stylelintrc.json
    Good: Linter or formatter configured (.stylelintrc.json).
  • build.sbt
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    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).
    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.
  • COPYING.md
  • crowdin.yml
  • devenv.lock
  • devenv.nix
  • devenv.yaml
  • flake.lock
  • flake.nix
  • LICENSE
    Good: Licensed under AGPL-3.0.
  • lila.sh
  • package.json
    Good: Dependency manifest found (package.json).
  • playwright.config.ts
  • pnpm-lock.yaml
    Good: Lockfile present (pnpm-lock.yaml). Installs are reproducible.
  • pnpm-workspace.yaml
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • svgo.config.mjs