Configuration

The configuration file is .considered.yaml at the repository root. It defines the standards to evaluate, the files to exclude, and any reviewed variances. It can also include guidance for coding agents.

This example enables all exclusion categories. The starter written byconsidered init enables only tests,vendored, and dependencies, plus gitignored files.

instructions: |
  Prefer small, focused changes.
  Preserve public APIs unless a variance explains the change.

kinds:
  - performance
  - compatibility

exclude:
  gitignored: true
  categories:
    - assets
    - configuration
    - documentation
    - generated
    - tests
    - vendored
    - dependencies
  paths:
    - src/generated/**

standards:
  scc.code_lines:
    max: 500
  scc.complexity:
    max: 50
  filesystem.bytes:
    max: 50000
  filesystem.longest_line:
    max: 140

warnings:
  percentBelowMax: 10
  percentAboveMin: 10

Instructions

instructions is optional free-form text, primarily intended for coding agents. A text considered check prints it before violations. Run considered instructions to print only this content.

Kinds

kinds adds repository-specific variance kinds. Built-ins arearchitectural, debt, and generated.

Standards

Standards are metric boundaries keyed by namespaced metric name. Each standard takes min, max, or both.

Warnings

Warnings report passing values that are close to a boundary.percentBelowMax: 10 warns when a passing value is at least 90% of a max boundary. percentAboveMin: 10 warns when a passing value is at most 110% of a min boundary. Percentages must be between 0 and 100. Omit a threshold to disable that warning direction; percentage warnings apply only to positive boundaries.

Warnings never fail the check. They apply to both standards and approved variance boundaries.