ready.yml

Optional project rules live in root ready.yml. The CLI, API payload builder, and PR workflow load this file so heuristics stay project-specific.

Example adapted from upstream:

testFilePatterns:
  - "**/*.test.ts"
  - "**/*.test.js"
  - "**/tests/**"
forbiddenPatterns:
  - "*.env"
  - "*.env.*"
  - "*.pem"
  - "*credentials*"
maxDiffSizeBytes: 102400
docsPathAllowlist:
  - "docs/**"
  - "**/*.md"
# Fixture demos + unit-test trees intentionally contain markers/sample secrets.
# Directory-scoped only — avoid bare **/*.spec.ts which can match non-test paths.
testPathAllowlist:
  - "tests/**"
  - "**/__tests__/**"
  - "fixtures/**"
customBlockers:
  # Comment-form only so ready.yml pattern/description lines do not self-match
  - pattern: "(?://|#)\\s*HACK\\b"
    severity: blocker
    description: "Unfinished-work markers in comments"
  - pattern: "(?://|#)\\s*no-commit\\b"
    severity: warning
    description: "Commit-blocking markers should be removed before PR"

Field guide

Field	Purpose
testFilePatterns	Globs treated as test files when assessing coverage signals
forbiddenPatterns	Paths that should not appear in a ready branch
maxDiffSizeBytes	Soft cap before large-diff handling
docsPathAllowlist	Docs soft-skips for line heuristics
testPathAllowlist	Ignore unit-test fixtures (including sample secrets) for line heuristics
customBlockers	Extra regex rules with blocker or warning severity

Tip

testPathAllowlist keeps fixture secrets under tests/** and fixtures/** from failing local hooks and CI heuristics. Keep it directory-scoped — bare globs like **/*.spec.ts can match non-test paths.

Caution

Write customBlockers patterns in comment form only (for example (?://|#)\\s*HACK\\b). If the pattern matches plain HACK text, the ready.yml description lines can self-match and fail the coach.