fix: prevent orphaned opening paragraphs in PR descriptions#393
Merged
Conversation
The git-commit-push-pr skill could produce PR bodies where the opening summary paragraph had no heading while subsequent sections used ## headings, making the first paragraph look like a missing heading on GitHub.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The git-commit-push-pr skill could produce PR bodies where the opening summary was a bare paragraph followed by
##-headed sections — rendering on GitHub as though the first heading was missing. This adds a "No orphaned opening paragraphs" writing principle: if the description uses section headings, the opening summary must also be under a heading (e.g.,## Summary). Short descriptions with no sections are unaffected.