Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hide pull request template comments #1306

Merged
merged 1 commit into from
Feb 27, 2025
Merged

Hide pull request template comments #1306

merged 1 commit into from
Feb 27, 2025

Conversation

robbibt
Copy link
Member

@robbibt robbibt commented Feb 27, 2025

This PR uses HTML <!--- ... ---> tags to hide the helpful comments in the pull request template when the markdown is rendered. This way, the info is there when someone writes the PR, but is hidden when another user views the PR.

e.g. In the markdown:

<!--- ⭐ This is a template you can follow to help construct a good pull request! --->

### Proposed changes
Include a brief description of the changes being proposed, and why they are necessary.

Rendered on Github:

Proposed changes

Include a brief description of the changes being proposed, and why they are necessary.

@robbibt
Copy link
Member Author

robbibt commented Feb 27, 2025

@BexDunn What do you think?

Copy link
Collaborator

@BexDunn BexDunn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it!!!

@robbibt robbibt merged commit 8ba312a into develop Feb 27, 2025
1 check passed
@robbibt robbibt deleted the pr_template_comments branch February 27, 2025 22:56
robbibt added a commit that referenced this pull request Feb 28, 2025
* Update PULL_REQUEST_TEMPLATE.md (#1288)

Updated the template with some additional links  and info and to de-prioritise testing on the NCI

* Update PULL_REQUEST_TEMPLATE.md (#1293)

removed duplicate checkbox

* Hide pull request template comments (#1306)

* accidental commit to develop

* added s2c to workflow

* re added accidentally remove cell

---------

Co-authored-by: Bex Dunn <[email protected]>
Co-authored-by: Robbi Bishop-Taylor <[email protected]>
Co-authored-by: Claire Phillips <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants