Skip to content

docs: place text of ticket in collapsible <details> in PR template - #5

Merged
kcrwfrd merged 1 commit into
mainfrom
feat/pull-request-template-ticket-details
Sep 23, 2026
Merged

kcrwfrd merged 1 commit into
mainfrom
feat/pull-request-template-ticket-details

Conversation

@kcrwfrd

@kcrwfrd kcrwfrd commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Jira ticket number:

Does this PR introduce a breaking change?

Are all of the original requirements satisfied in this PR?

Text of the Ticket

A make-believe ticket title

There is no ticket, this is only intended as a demonstration.

What is the current behavior?

What is the new behavior?

Ticket contents are rendered in a collapsible <details> element.

See example PR: https://github.com/MapQuest/quest/pull/1068

Screenshot 2026-09-23 at 2 20 05 PM Screenshot 2026-09-23 at 2 20 11 PM

How to test

Motivation and context

The Jira ticket is intended to be copied into the "Text of the Ticket" section for improved context of automated AI reviewers. This content, especially when verbose, can be very distracting for humans.

When editing Markdown in the Github Markdown editor, you can try using the /details command to interactively create a collapsible <details> section. It uses HTML markup because there is no direct Markdown equivalent for such a section.

https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/details

Checklist

  • I have performed a self-review of my code and the expected functionality
  • I have added tests that prove that my feature works or my fix is effective
  • I have made any necessary changes to the documentation
  • The changes introduced can go live immediately with stakeholder approval
  • Product or Business stakeholders have performed acceptance testing

@kcrwfrd
kcrwfrd requested review from Ignigena and a lite review from Copilot September 23, 2026 21:28

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The change is limited to template markup, with only a minor nit noted.

Review effort: Lite
Findings: None

What changed in this PR

Updates the PR template to place Jira ticket text in a collapsible <details> section.

Changes:

  • Adds a ticket-title summary placeholder.
  • Wraps ticket content in collapsible markup.
File Description
PULL_REQUEST_TEMPLATE.md Adds collapsible ticket details to the PR template.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@kcrwfrd
kcrwfrd merged commit 47d6ea8 into main Sep 23, 2026
1 check passed
@kcrwfrd
kcrwfrd deleted the feat/pull-request-template-ticket-details branch September 23, 2026 22:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants