BUG: Nested lists, tables, git trailers mangled by hard wrapping from "Pull request title and description" default commit message setting

[huonw]

Select Topic Area

Bug

Body

The "Default commit message: Pull request title and description" setting is nice, to automatically fill out commit messages with useful information.

This process involves hard-wrapping the text to align to Git's "72 characters" guideline, which is good in most cases.

However, the current algorithm mangles several useful constructs, causing the meaning to change and thus the commit message to be somewhere between "hard to read", "misleading", and "missing critical information". For instance:

• nested lists with wrapped lines have the nesting removed (all list items at the top level)
• tables have breaks inserted in the middle of rows, turning a one row into 2+, with data in the wrong columns (or just totally breaking the table syntax, depending on the position of the break)
• git trailers are wrapped in a way that violates the specification, stopping them from being machine readable.

Notably, the hard-wrapping algorithm isn't completely naive: it already avoids wrapping long lines within code blocks (yay).

Expected behaviour

It would be great if the hard-wrapping had better handling of these extra constructs, in addition to its existing handling of code blocks:

• nested lists: still wrap, but preserve the nesting, e.g. determine the nesting depth/leading whitespace, wrap each line slightly narrower (based on the width of the whitespace + 1. or - indicator), then re-insert appropriate leading spaces as a prefix on all wrapped lines
• tables: avoid wrapping
• git trailers: avoid wrapping, or, insert lead whitespace to match the spec

Thanks!

Example

• PR: PR with long lines in the description huonw/github-bug-default-message-pr-description-wrapping#2
• Commit: huonw/github-bug-default-message-pr-description-wrapping@cb36d13
• Example rendering of the commit message (also included below): PR with long lines in the description huonw/github-bug-default-message-pr-description-wrapping#2 (comment)

Expand for original rendering

Desirable behaviour

Here's a normal paragraph with long lines that would be preferable to be wrapped, following, for instance, https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project.html#_commit_guidelines which says "Wrap it to about 72 characters or so".

This is a code block with a very long line which isn't wrapped, and the line keeps going and going and going and going and going and going and going and going and going and going and going

Undesirable behaviour

• bullet list with very long lines: so so so so so so so so so so so so so so so so so so long
  • nested one level and the line keeps going and going and going and going and going and going and going and going and going and going and going
    • this is nested two levels and is very very very very very very very very very very very very very very very very very very long

1. numbered list with very long lines: so so so so so so so so so so so so so so so so so so long
   1. nested one level and the line keeps going and going and going and going and going and going and going and going and going and going and going
      1. this is nested two levels and is very very very very very very very very very very very very very very very very very very long

table	with	long	lines
A	a b c d e f g h i j k l m n o p q r s t u v w x y z	0 1 2 3 4 5 6 7 8 9	a b c d e f g h i j k l m n o p q r s t u v w x y z
B	0 1 2 3 4 5 6 7 8 9	a b c d e f g h i j k l m n o p q r s t u v w x y z	0 1 2 3 4 5 6 7 8 9

Demo-Trailer: this is a very long line and also here's the spec that says "may be split over multiple lines with each subsequent line starting with at least one whitespace" https://git-scm.com/docs/git-interpret-trailers

Expand for mangled commit message rendering

Desirable behaviour

Here's a normal paragraph with long lines that would be preferable to be
wrapped, following, for instance,
https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project.html#_commit_guidelines
which says "Wrap it to about 72 characters or so".

This is a code block with a very long line which isn't wrapped, and the line keeps going and going and going and going and going and going and going and going and going and going and going

Undesirable behaviour

• bullet list with very long lines: so so so so so so so so so so so so
  so so so so so so long
• nested one level and the line keeps going and going and going and
  going and going and going and going and going and going and going and
  going
• this is nested two levels and is very very very very very very very
  very very very very very very very very very very very long

1. numbered list with very long lines: so so so so so so so so so so so
   so so so so so so so long
2. nested one level and the line keeps going and going and going and
   going and going and going and going and going and going and going and
   going
3. this is nested two levels and is very very very very very very very
   very very very very very very very very very very very long

table	with	long	lines
A	a b c d e f g h i j k l m n o p q r s t u v w x y z	0 1 2 3 4 5
6 7 8 9	a b c d e f g h i j k l m n o p q r s t u v w x y z
B	0 1 2 3 4 5 6 7 8 9	a b c d e f g h i j k l m n o p q r s t u v
w x y z	0 1 2 3 4 5 6 7 8 9

Demo-Trailer: this is a very long line and also here's the spec that
says "may be split over multiple lines with each subsequent line
starting with at least one whitespace"
https://git-scm.com/docs/git-interpret-trailers

See also

• prior discussion: https://github.com/orgs/community/discussions/30439
• particularly comment: https://github.com/orgs/community/discussions/30439#discussioncomment-13869067

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐