docs: add pre-commit exclude pattern guidance for large/generated dirs

[endavis]

Documentation Type

Configuration guidance

Description

Add comments in .pre-commit-config.yaml showing where to add project-specific exclusions for check-added-large-files and detect-private-key hooks. Currently there's no guidance, so downstream projects don't know the right place to add exclusions without breaking hook config.

Example:

- repo: https://github.com/pre-commit/pre-commit-hooks
  hooks:
    - id: check-added-large-files
      # Add project-specific exclusions for large data/generated directories:
      # exclude: ^(vendor/|fixtures/|data/)
    - id: detect-private-key
      # Exclude directories with non-secret key-like patterns:
      # exclude: ^(example-config/|test-fixtures/)

[endavis]

Implementation Plan for #294: docs: add pre-commit exclude pattern guidance for large/generated dirs

Context

Downstream projects forking the template don't know where to add project-specific exclusions for check-added-large-files and detect-private-key hooks. Adding inline comments provides guidance without breaking hook config.

Overview

Add commented-out exclude: examples after the check-added-large-files and detect-private-key hook entries in .pre-commit-config.yaml.

Files to Modify

• .pre-commit-config.yaml:12-19 — Add guidance comments after check-added-large-files (line 12) and detect-private-key (line 18)

Test Plan

• No unit tests needed (comment-only change)
• doit check passes
• pre-commit run --all-files still works (comments don't break YAML)

Documentation

• No other docs to update
• ADR needed: no

Validation

• doit check passes
• YAML remains valid after adding comments

[endavis]

Addressed in PR #324