From d1a5759795127c61507d060d31789e9f9e93553a Mon Sep 17 00:00:00 2001 From: Marco Walz Date: Tue, 12 May 2026 11:19:22 +0200 Subject: [PATCH 1/2] docs(agents): require PR description updates when pushing to a PR branch --- AGENTS.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 2995427..ef2d799 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -90,6 +90,15 @@ EOF git checkout main ``` +**Any time commits are pushed to a PR branch** — check whether the PR description still accurately reflects the complete set of changes on the branch. If new commits introduce changes not covered by the existing summary, update the description immediately: +```bash +gh pr edit --body "$(cat <<'EOF' + +EOF +)" +``` +Do not leave a PR description that no longer matches the branch. The description is the reviewer's first read; a stale summary wastes review time and creates confusion. + **Rebase approved PR with merge conflicts:** ```bash git fetch origin && git checkout From 61aecf4ee12a3ceb648260e9c338c9c9668a2477 Mon Sep 17 00:00:00 2001 From: Marco Walz Date: Tue, 12 May 2026 11:21:35 +0200 Subject: [PATCH 2/2] docs(agents): add PR body heredoc formatting rule to prevent escaped backticks --- AGENTS.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index ef2d799..f4d1963 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -99,6 +99,8 @@ EOF ``` Do not leave a PR description that no longer matches the branch. The description is the reviewer's first read; a stale summary wastes review time and creates confusion. +**PR body formatting rule (applies to `gh pr create`, `gh pr edit`, and `gh pr comment`)** — always pass the body through a single-quoted heredoc (`<<'EOF'`). Single-quoted heredocs suppress all shell expansion, so backticks and other special characters are passed through literally. Never manually escape backticks with `\`` inside the heredoc: the backslash will appear verbatim in the rendered output. + **Rebase approved PR with merge conflicts:** ```bash git fetch origin && git checkout