Clarify details of the default template #5429
Merged
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.
Currently, this bit of the documentation refers to "the following template", which never materialises. This is a reference to a time when the default template was included inline.
To help future readers, I think offering a link to the template would work better. There's already a link in the subsequent info box, but it's a bit out of sight for readers of the initial paragraph. I have reworded this one too to something I think will look more cohesive and useful.