docs: comment instructions for PR template#1710
Merged
Merged
Conversation
Updated the pull request template to include comment descriptions for each section.
Clarify the purpose of the summary section in the pull request template.
wesleyboar
requested review from
fnets,
nathanfranklin,
nessasmithhh and
rstijerina
and removed request for
rstijerina
fnets
approved these changes
Jun 2, 2026
fnets
left a comment
fnets
left a comment
Contributor
There was a problem hiding this comment.
I think this would be helpful! Although, I guess we could make the argument that if the template is complicated enough that we need comments, we might want to simplify the template.
Ending heading with hashes is redundant. Heading text needs no colon; colon is for content text that introduces more content.
Collaborator
Author
|
Updates:
|
rstijerina
approved these changes
Jun 2, 2026
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
3 participants
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.
Overview:
Updated the pull request template to include comment descriptions for each section.
Note
💡 Consider deleting "Summary of Changes" (seems redundant given "Overview").
PR Status:
Related Jira tickets:
Summary of Changes:
.github/pull_request_template.mdTesting Steps:
https://github.com/DesignSafe-CI/portal/blob/docs/pr-template-comments/.github/pull_request_template.md
UI Photos:
See raw content or just the diff.
Notes:
I've added different PR template comments in TACC/Core-CMS and TACC/Core-Styles. This PR adds comments that respect what I have seen in DesignSafe PRs.