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

Issue templates: use HTML comments #2269

Merged
merged 1 commit into from
May 29, 2021

Conversation

Akarys42
Copy link
Contributor

This commit makes use of HTML comments inside GitHub issue templates
to make sure that even if they aren't removed by the issue author they won't be shown
in the rendered output.

The goal is to simply make the issues less noisy by removing template messages.

You can try them out on my fork. I haven’t added a news entry as this doesn’t seem to fit, let me know if it needs one! 😁

This commit makes use of HTML comments inside GitHub issue templates
to make sure that even if they aren't removed by the issue author they won't be shown
in the rendered output.

The goal is to simply make the issues less noisy by removing template messages.
@felix-hilden
Copy link
Collaborator

I had a go and created empty issues for each category: Akarys42#1, Akarys42#2 and Akarys42#3. Looks good!

@ichard26 ichard26 added the skip news Pull requests that don't need a changelog entry. label May 28, 2021
Copy link
Collaborator

@ichard26 ichard26 left a comment

Choose a reason for hiding this comment

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

Weee! Thank you!

@JelleZijlstra JelleZijlstra merged commit 7f138c1 into psf:main May 29, 2021
@JelleZijlstra
Copy link
Collaborator

Thanks!

@Akarys42 Akarys42 deleted the html-comments-in-issue-templates branch May 29, 2021 17:16
@ichard26
Copy link
Collaborator

Thank you so much for your contribution! You're awesome, @Akarys42! Congrats on your first PR to psf/black and the psf in general. FYI, we have been trying to improve the contributing experience and are looking for feedback. It would be great if you share yours if you have any, more details here: #2238.

Merci beaucoup encore!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip news Pull requests that don't need a changelog entry.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants