Use GitHub PR template file when creating pull requests #1209
+58
−18
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.
Use GitHub PR template file when creating pull requests
Summary
This PR makes
sl pr submitrespect the standard GitHub pull request template file (.github/pull_request_template.md) when creating pull requests, matching GitHub's native behavior.Previously, Sapling would ignore the PR template and use the commit message body (or append the template to it), which was inconsistent with how GitHub's web UI works.
Changes
github.pull-request-templateto customize the template path or disable the featureConfig Options
When not configured, checks standard GitHub locations:
This is consistent with the GitHub documentation https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository
Test Plan