hmbown--codewhale/.github/PULL_REQUEST_TEMPLATE.md at debug/win-python

Files

T

Hunter B d38ed6445e docs: document truthful pre-push verification gates

CONTRIBUTING.md gains a "Pre-push verification" section stating what is
actually enforced today, without assuming machinery that does not exist:

- the exact normal pre-push commands, matching the CI pull-request lane
  (fmt --check, workspace clippy with the CI allow list under
  -D warnings, workspace tests, all --locked);
- the stricter release clippy form (--all-targets --all-features), which
  the release lane runs and the PR template asks for, with the reason it
  matters (test/bench targets are otherwise unlinted until release);
- the slow / platform-bound isolation cases and how to treat them: the
  Unix-only serialized qa_pty suite (one documented #[ignore] case;
  rerun exact failing cases in isolation before calling a flake, with
  run_verifiers_background_* as the one known parallelism flake), the
  #[ignore]d 32-worker release_runtime_qa storm benchmark, and the
  macOS-gated OCR (Vision/tesseract) and seatbelt sandbox paths;
- that git hooks are optional local automation the contributor adds
  themselves — this repository installs no hooks and has no hook
  installer; CI is the enforced gate;
- that a local hook must only verify and report: never push, tag,
  publish, deploy, mutate credentials, or rewrite the working tree;
- how to bypass one's own hook for a knowingly documented reason
  (git push --no-verify, stated in the PR) without ever reporting a
  bypassed gate as a passing one;
- that release publication stays a separate owner-approved gate that no
  green local run or hook authorizes.

The two older command blocks in CONTRIBUTING.md now point at the single
section instead of drifting, and the PR template checklist picks up
--locked plus a pointer to the exact allow-list gate so template,
CONTRIBUTING, and CI describe the same commands.

2026-07-23 17:59:06 -07:00

569 B

Raw Permalink Blame History

Summary

Testing

cargo fmt --all -- --check
cargo clippy --workspace --all-targets --all-features --locked (warning-free under the CI allow list)
cargo test --workspace --all-features --locked

Checklist

Updated docs or comments as needed
Added or updated tests where relevant
Verified TUI behavior manually if UI changes
Harvested/co-authored credit uses a GitHub numeric noreply address

569 B Raw Permalink Blame History

Summary

Testing

Checklist

569 B

Raw Permalink Blame History