Convert the GitHub issue templates into GitHub issue forms#107920
Merged
Conversation
AA-Turner
reviewed
Aug 13, 2023
AA-Turner
left a comment
Member
There was a problem hiding this comment.
Good idea! I think there are some presentational issues (YAML multilines...) and a few points on wording/content.
A
AlexWaygood
commented
Aug 13, 2023
AlexWaygood
commented
Aug 13, 2023
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
ezio-melotti
left a comment
Member
There was a problem hiding this comment.
Some of the comments (e.g. dropdown for the OSs and removing a few textareas) apply to all forms.
In addition, are you planning to convert the documentation template too?
AlexWaygood
commented
Aug 13, 2023
AA-Turner
reviewed
Aug 13, 2023
AlexWaygood
commented
Aug 13, 2023
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Member
Author
I don't think it really needs changing? Most of the docs issues that are filed don't seem like they're particularly lacking in information to me. In my opinion it's fine to leave the docs template as-is, unless you disagree :) |
hugovk
reviewed
Aug 13, 2023
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
ezio-melotti
approved these changes
Aug 13, 2023
hugovk
reviewed
Aug 13, 2023
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
hugovk
reviewed
Aug 13, 2023
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
AA-Turner
reviewed
Aug 14, 2023
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AA-Turner
approved these changes
Aug 14, 2023
AA-Turner
left a comment
Member
There was a problem hiding this comment.
Thanks again, all looks good!
A
Member
Author
|
Thanks everybody for the thorough reviews, much appreciated! |
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
6 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.
This creates a much nicer interface for users filing issues with CPython.
Issue templates only apply to the
mainbranch, so there's no way of testing these changes unless they're already merged into themainbranch of a GitHub repository. Therefore, that's what I've done with my fork! These changes have already been merged into themainbranch of https://github.com/AlexWaygood/cpython. Feel free to create issues over at my fork and test out what the experience of filling in the forms is like. I've also created some example issues so that you can see how the bug reports are rendered after the form has been filled in:bazfeature AlexWaygood/cpython#13IndexErrorwhen usingfoo()AlexWaygood/cpython#14bar()AlexWaygood/cpython#15Documentation for this GitHub feature can be found here: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms. (This page also includes an example of how to convert an existing issue template into an issue form.)
Detailed documentation for the permitted syntax in GitHub forms can be found here: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema