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

Improve the feature-proposal issue form #108033

Merged
merged 6 commits into from
Aug 16, 2023
Merged

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Aug 16, 2023

A small followup to #107920, now we've had a few days' experience of people using the issue forms:

  • Convert the "I have/haven't discussed this feature on Discourse" checkbox into a dropdown. It doesn't make sense to check both of these boxes; a dropdown makes more sense here.
  • Get rid of the demand that people provide a one-sentence summary of their proposal. This makes sense for some feature proposals, but not for others. For people who want to provide a summary, they can probably just integrate it into the main body of their feature proposal.

As before, I've pushed these changes to the main branch of my GitHub form, so you can try creating an issue at https://github.com/AlexWaygood/cpython to see how the form renders.

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@AlexWaygood
Copy link
Member Author

One other change we could make: prior to the new issue forms, the issue templates had big titles at the top: if it was a bug report, the title at the top was "Bug report"; if it was a feature request, the title at the top was "Feature request". I sort-of miss those -- it was easy to see at-a-glance what kind of an issue you were dealing with if you had it open. Should we bring them back?

Examples of how they looked until recently:

@AlexWaygood
Copy link
Member Author

@erlend-aasland, it looked like the new checkboxes in the feature-request form might have been annoying you a bit in #108021. Would you prefer a dropdown selection, like this PR proposes? (Example of how it renders with the drop-down: AlexWaygood#16.)

@AA-Turner
Copy link
Member

big titles at the top

These would be useful to bring back I think

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@AlexWaygood
Copy link
Member Author

One other change we could make: prior to the new issue forms, the issue templates had big titles at the top: if it was a bug report, the title at the top was "Bug report"; if it was a feature request, the title at the top was "Feature request". I sort-of miss those -- it was easy to see at-a-glance what kind of an issue you were dealing with if you had it open. Should we bring them back?

I'm actually not sure this is possible, unfortunately :/

You can create a custom markdown block of text that will be shown to the user as they're submitting the form, but that doesn't get rendered into the issue report once the form's been completed. We can pre-fill a textarea input section with # Bug report, but then users can add custom content to that textarea section. We can pre-fill issue report titles, so that bug reports all start with "Bug:", but that might be annoying when scrolling through the issue tracker (we already have the type-bug, type-feature, etc. labels).

@AlexWaygood
Copy link
Member Author

We could maybe have it so that the textarea input at the bottom comes prefilled with # Bug report, # Feature request or # Crash report -- would that be an improvement? It'll just be hard to get it so that the # Bug report title comes above the checklist items

@AA-Turner
Copy link
Member

I'm actually not sure this is possible, unfortunately :/

We could use something akin to https://github.com/python/cpython/blob/main/.github/workflows/documentation-links.yml to add the block of text depending on which label has been applied?

A

@AlexWaygood
Copy link
Member Author

We could use something akin to https://github.com/python/cpython/blob/main/.github/workflows/documentation-links.yml to add the block of text depending on which label has been applied?

Alright, I'll try to tackle that in a followup PR 😄

@erlend-aasland
Copy link
Contributor

@erlend-aasland, it looked like the new checkboxes in the feature-request form might have been annoying you a bit in #108021. Would you prefer a dropdown selection, like this PR proposes? (Example of how it renders with the drop-down: AlexWaygood#16.)

Yeah, the most irritating thing was that after I finally had been allowed to create the issue, GitHub of course showed it as an issue with two tasks, which was of course completely wrong. When browsing issues, task status is also shown (for example 2 or 4 tasks complete, or something similar). I wanted to get rid of that for my issue; it just did not make any sense, and you could get the wrong impression of the progress of the issue just by browsing the issue list.

@AlexWaygood
Copy link
Member Author

Okay, let's try this out, then. I think this reduces the friction for core devs a bit and makes the form more flexible, but we can continue iterating if we still don't feel like it's working well 👍

@AlexWaygood AlexWaygood merged commit 8891a88 into python:main Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants