Skip to content

docs(agents): require PR description updates when pushing to a PR branch #244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
marc0olo wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −0
Open

docs(agents): require PR description updates when pushing to a PR branch #244

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1a5759
docs(agents): require PR description updates when pushing to a PR branch
marc0olo May 12, 2026
61aecf4
docs(agents): add PR body heredoc formatting rule to prevent escaped …
marc0olo May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,17 @@ 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 <PR#> --body "$(cat <<'EOF'
<updated full description>
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 <branch>
Expand Down
Loading