A high-traffic AI chat project with good docs and tests, but contributors hit friction quickly: vague contributing guide, 240 open issues unreviewed, and stalled maintenance signals.

20 of 34 checks passed across 6 categories.

• Machine Orientation

  ✓2 checks passed⚠5 problems found

  • mediumAgent instructions file

    AGENTS.md / CLAUDE.md is the direct, machine-read channel for entry points and conventions.

    Fix: Add an AGENTS.md naming the entry points, the build/test commands, and the house conventions.

  • lowllms.txt present

    An llms.txt is the emerging machine-orientation standard — a curated map for LLMs.

    Fix: Add an llms.txt pointing at the key docs and entry points.

  • lowTopics set

    GitHub topics situate the repo's domain and stack for an agent at a glance.

    Fix: Add a few GitHub topics describing the domain and stack.

  • lowArchitecture doc

    An ARCHITECTURE doc hands an agent the module map instead of making it infer one.

    Fix: Add an ARCHITECTURE.md describing the major components and how they fit.

  • lowContribution conventions are written down

    A contributor guide is where an agent learns the branch, commit, and review conventions it must follow.

    Fix: Add a CONTRIBUTING.md stating the branch naming, commit format, and how a change gets reviewed.

  • ✓README present — An agent reconstructs what the repo is and how to work in it from the README first.
  • ✓Repository description set — The one-line description is the fastest orientation signal an agent reads.

• Reproducible Setup

  ✓3 checks passed⚠3 problems found

  • mediumContainer or dev-container

    A Dockerfile / compose / devcontainer removes 'works on my machine' from setup.

    Fix: Add a Dockerfile, a compose file, or a .devcontainer so the environment is declared, not assumed.

  • lowEnv template present

    A .env.example tells an agent which configuration keys it must supply to run.

    Fix: Ship a .env.example listing every required key with placeholder values.

  • lowDev container

    A .devcontainer gives an agent a one-command, fully-declared environment.

    Fix: Add a .devcontainer so the toolchain is declared, not assumed.

  • ✓Lockfile committed — Without a lockfile two clones can resolve different dependency trees — the build isn't reproducible.
  • ✓Runtime / toolchain pinned — An unpinned runtime makes an agent guess the version a clean environment needs.
  • ✓Version pins are exact — A floating pin (a bare major, or a range) still drifts between installs.

• Code Navigability

  ✓2 checks passed⚠0 problems found

  • ✓Conventional source layout — A recognised src/ · lib/ · app/ layout lets an agent localise code without spelunking.
  • ✓TypeScript strict mode on — Strict typing gives an agent typed signatures to anchor an edit on, not guesses.

• Verification Surface

  ✓5 checks passed⚠2 problems found

  • mediumCI configured

    Readable CI is the feedback loop an agent reads to know what 'green' means here.

    Fix: Add a CI workflow (e.g. under .github/workflows) that runs the build and tests.

  • lowTask runner present

    A Makefile / Taskfile / justfile gives an agent a single index of the project's commands.

    Fix: Add a Makefile / Taskfile / justfile collecting the common commands.

  • ✓Tests present — Runnable tests are the ground truth an agent checks its own edits against.
  • ✓Test command defined — A `test` script is the documented, discoverable way to run the suite.
  • ✓Lint command defined — A linter an agent can run catches a class of mistakes before they ship.
  • ✓Typecheck command — A typecheck script lets an agent catch type errors before they ship.
  • ✓Build command — A documented build command is the discoverable way for an agent to produce artifacts.

• Agent Safety

  ✓5 checks passed⚠3 problems found

  • mediumSecurity policy

    A SECURITY.md is where an autonomous security agent reads this repo's rules before acting on it.

    Fix: Add a SECURITY.md stating the disclosure channel and the repo's security rules.

  • lowCODEOWNERS present

    CODEOWNERS marks the 'don't touch without review' zones an agent should respect.

    Fix: Add a CODEOWNERS file marking the sensitive paths.

  • lowAutomated dependency updates

    Dependabot / Renovate keeps dependencies patched without a human in the loop.

    Fix: Enable Dependabot or Renovate.

  • ✓No committed .env — A tracked real .env hands secrets to anything — including an agent — that reads the repo.
  • ✓No exposed secrets — Secret-shaped literals in tracked files are a live credential leak.
  • ✓.gitignore covers env files — An ignore rule for .env is what keeps the next careless commit from leaking secrets.
  • ✓.gitignore present — A .gitignore is the first guard against an agent committing secrets or build junk.
  • ✓License makes the code reusable — Without a license an agent cannot safely copy, redistribute, or vendor any of this code.

• Context Economy

  ✓3 checks passed⚠1 problem found

  • lowGenerated / vendored files marked

    A .gitattributes linguist marker tells tools (and agents) what to skip.

    Fix: Mark generated/vendored paths in .gitattributes (linguist-generated / linguist-vendored).

  • ✓Dependencies not vendored in — A committed node_modules / vendor tree drowns the real signal an agent needs.
  • ✓Build output not committed — Generated dist/ · build/ output is noise an agent has to read past.
  • ✓No oversized source file — A single file in the hundreds of KB blows past an agent's effective context window.

12 of 25 checks passed across 6 categories.

• First Impression

  ✓2 checks passed⚠1 problem found

  • lowTopics set

    Topics situate the project's domain at a glance and help a newcomer find it.

    Fix: Add a few GitHub topics describing the domain and stack.

  • ✓README present — The README is the first screen — with none, a newcomer has nothing to land on.
  • ✓Repository description set — The one-line description sets expectations before a newcomer even opens the README.

• Getting Running

  ✓3 checks passed⚠3 problems found

  • mediumOne-command environment

    A Dockerfile / compose / devcontainer turns a fiddly setup into one command.

    Fix: Add a Dockerfile, a compose file, or a .devcontainer for a one-command setup.

  • lowEnv template present

    A .env.example shows a newcomer exactly which settings they must fill in to run it.

    Fix: Ship a .env.example listing every required key with placeholder values.

  • lowOne-click dev container

    A .devcontainer lets a newcomer start in a cloud IDE with zero local setup.

    Fix: Add a .devcontainer for a one-click, batteries-included environment.

  • ✓Lockfile committed — Without a lockfile a newcomer's install resolves differently and hits errors the docs don't mention.
  • ✓Prerequisite versions pinned — Unpinned prerequisites are the classic 'works on my machine' first-run failure.
  • ✓Versions pinned exactly — A floating version still drifts — a newcomer can hit a break the maintainer never saw.

• Finding Your Way

  ✓2 checks passed⚠1 problem found

  • mediumArchitecture / overview doc

    An overview hands a newcomer the map instead of making them reconstruct it.

    Fix: Add an ARCHITECTURE.md (or a 'Project layout' README section) naming the key directories.

  • ✓Conventional source layout — A familiar src/ · lib/ · app/ layout lets a newcomer guess where things live.
  • ✓No oversized source file — A single thousand-line file is a wall a newcomer bounces off.

• Path to Contribute

  ✓2 checks passed⚠4 problems found

  • mediumCONTRIBUTING guide

    A CONTRIBUTING guide is the difference between a guessed and a guided first PR.

    Fix: Add a CONTRIBUTING.md covering dev setup, the test command, and how to submit a change.

  • lowIssue templates

    Issue templates show a newcomer how to file something useful — and that contributions are welcome.

    Fix: Add issue templates under .github/ISSUE_TEMPLATE.

  • lowPull-request template

    A PR template tells a first-time contributor what a good change includes.

    Fix: Add a PULL_REQUEST_TEMPLATE.md.

  • lowTask runner

    A Makefile / Taskfile gives a contributor a single index of the project's commands.

    Fix: Add a Makefile / Taskfile collecting the common dev commands.

  • ✓Test command defined — A documented test command lets a contributor check their change before opening a PR.
  • ✓Lint command — A linter lets a first-time contributor catch style issues before review.

• Signs of Life

  ✓1 check passed⚠2 problems found

  • mediumCI configured

    Green CI on every change tells a newcomer the project is actively kept working.

    Fix: Add a CI workflow that runs on every push and pull request.

  • lowAutomated dependency updates

    Dependabot / Renovate activity is a visible heartbeat of ongoing maintenance.

    Fix: Enable Dependabot or Renovate.

  • ✓Tests present — A test suite signals a project that's cared for, not abandoned.

• Open Door

  ✓2 checks passed⚠2 problems found

  • lowCode of conduct

    A code of conduct states the social ground rules that make it safe to step in.

    Fix: Add a CODE_OF_CONDUCT.md (the Contributor Covenant is the de-facto standard).

  • lowSecurity policy

    A SECURITY.md tells a newcomer how to report a problem responsibly.

    Fix: Add a SECURITY.md describing how to report a vulnerability.

  • ✓License present — With no license the project isn't legally reusable — the door is shut however friendly the README.
  • ✓License is a standard one — A non-standard or custom license is a legal question mark a newcomer won't resolve.