Skip to main content

Contributing

Tentacrawl follows a deliberate set of conventions so that human and AI contributors alike can work in the codebase predictably. The authoritative sources are two files at the repository root:

  • CONTRIBUTING.md — setup, local validation, commit and pull request conventions, and how releases work.
  • AGENTS.md — the working conventions for the codebase itself: module layout, naming, type safety, testing, and code style.

This page is intentionally short and does not duplicate them; read those two files first.

The short version​

pnpm install
pnpm exec playwright install chromium
pnpm generate
pnpm lint && pnpm typecheck && pnpm test && pnpm build

Every pull request runs .github/workflows/ci.yml (lint, build and test, and a check that generated registries are up to date). Pull requests are squash merged, and the pull request title becomes the commit message and drives the release — see Conventional Commits and the commit conventions in CONTRIBUTING.md.

Where to start​

  • Adding a new feature module: see Module System and the deterministic layout in AGENTS.md.
  • Adding a Challenger extension: see Extending Tentacrawl.
  • Improving these docs: pages live under apps/docs/docs/; every page has an "Edit this page" link that opens the file directly on GitHub.