diff --git a/.github/agent/probe-issue.md b/.github/agent/probe-issue.md index 8f906ef..92ec507 100644 --- a/.github/agent/probe-issue.md +++ b/.github/agent/probe-issue.md @@ -26,3 +26,7 @@ Key points: you are skeptical of the docs, you write tests that run via CI, `run_tox` validates format/lint/unit but CI is the ultimate arbiter, and you must write a `.PR.md` file (markdown with a `# ` title heading) when done. If you cannot proceed, emit `IMPLEMENTATION_BLOCKER:` instead. + +When writing `.PR.md` or any markdown output, **never hard-wrap lines**. +Write each paragraph as a single long line — the markdown renderer handles +wrapping. Hard-wrapped lines look sloppy and break rendering. diff --git a/.github/scripts/probe_issue.py b/.github/scripts/probe_issue.py index bd00220..371a089 100644 --- a/.github/scripts/probe_issue.py +++ b/.github/scripts/probe_issue.py @@ -579,9 +579,10 @@ def test_config_changed_survives_pebble_ready(): is true, what the PR tests, and what green (or red) CI means for each claim. \ Use proper markdown: headers (`##`), bullet points, code blocks (fenced \ with triple backticks), and paragraphs separated by blank lines. -- **Do not hard-wrap lines.** Write each paragraph as a single long line — \ -the markdown renderer handles wrapping. Hard-wrapped lines break rendering \ -and make editing harder. +- **Never hard-wrap lines.** Write each paragraph as a single long line — \ +the markdown renderer handles wrapping. Hard-wrapped lines look sloppy in \ +the rendered PR and signal carelessness. This applies to the body, bullet \ +points, and code comments — everywhere in `.PR.md`. - **Do not include a "Changes" or "Files changed" section.** The reviewer \ can see the diff in GitHub. Focus on reasoning, not a file listing.