Skip to content

Clarify agent issue body formatting rules #1877

Description

@davidsneighbour

Plain Markdown issue bodies created by agents can accidentally render labels as large headings, and Markdown-heavy text passed through gh issue create --body can be corrupted by shell interpretation.

Update .agents/instructions/issue-handling.instructions.md so future issue creation:

  • avoids Markdown headings in issue bodies unless a structured template is explicitly requested,
  • prefers plain labels or bullet lists for agent-created issues,
  • uses gh issue create --body-file for Markdown-heavy issue bodies, command examples, code spans, backticks, or multi-paragraph text.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    prio:lowLow priority, including the default when no higher priority is supported.status:confirmedConfirmed and accepted as valid work, but not yet in active implementation.type:documentationTechnical, project, process, reference, or usage documentation.

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions