Skip to main content

Git integration

Git integration connects your source repository to a TestChimp project so test plans and automation stay versioned with your code, and tools like the TestChimp skill + @testchimp/cli can resolve coverage, paths, and sync PRs predictably.

Git integration: repository selection and folder mapping

What you configure​

For each project you:

  1. Select the Git repository that contains (or will contain) your SmartTests and markdown test plans.
  2. Map two folders in that repository to TestChimp’s logical tests and plans roots.

On disk the folder names can be anything your team prefers (for example ui/tests and ui/plans). TestChimp still treats them as the platform tests and plans trees for APIs, coverage scope, and MCP path rules.

Folder 1: Tests (tests/ mapping)​

This folder is the SmartTests root—the place you run npx playwright test from and where @testchimp/playwright is wired in playwright.config.

Role

  • Holds Playwright automation (SmartTests): UI and API tests, fixtures, helpers, and CI config.
  • Receives .testchimp-tests (marker file) after sync so agents and tooling can unambiguously find the SmartTests root.
  • Is where // @Scenario: (and similar) traceability comments live so requirement coverage and execution history roll up correctly.

Use this mapping for everything that executes in a browser or against your APIs in the TestChimp workflow.

Folder 2: Plans (plans/ mapping)​

This folder is the markdown test-planning root: user stories, test scenarios, knowledge files, and optional event specs used for TrueCoverage and planning.

Role

  • Holds agent-readable markdown (with frontmatter) organized in stories/, scenarios/, knowledge/, etc., so /testchimp test and /testchimp evolve can scope work from the same files you see in the web app.
  • Syncs from TestChimp → Git (and back) so plans live next to code for review and diffs.
  • Receives .testchimp-plans (marker file) after sync so the plans root is explicit for agents and MCP plans/... paths.

Use this mapping for intent: what to validate, priorities, and structured context—not for Playwright execution itself.

Why two folders matter​

  • Separation of concerns: Plans = what we intend to verify; tests = how we automate verification.
  • Skill + MCP contract: Many tools (coverage scope, plan queries, “run from SmartTests root”) assume the two roots exist and are mapped; markers make them discoverable even in monorepos.
  • Shift-left: The same PR can change product code, plans, and tests together—reviewers see the full story in one diff.

Where to set it up in the app​

In TestChimp → your project → Project settings → Integrations → Git, connect the repository and complete both folder mappings, then use the product’s sync flow so marker files and initial structure land in the repo (see also /testchimp init).

See also​