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

Makes issue templates forms #1578

Merged
merged 1 commit into from
Nov 9, 2023
Merged

Makes issue templates forms #1578

merged 1 commit into from
Nov 9, 2023

Conversation

andresgalante
Copy link
Contributor

Feel free to close this PR if forms for issue templates are not your cup of tea. I enjoy them since they keep reports tidy.

You can see a preview of it here.

image

@jhrozek
Copy link
Contributor

jhrozek commented Nov 7, 2023

This is something @dussab might have an opinion about

@andresgalante
Copy link
Contributor Author

The biggest drawback to this approach is that project maintainers don't need to follow the forms, and they become REALLY annoying. For that, there is a small link at the bottom of the template selection to open a blank issue:

image

@dussab
Copy link
Contributor

dussab commented Nov 8, 2023

@andresgalante Thanks for these suggestions to keep things tidy! Some feedback and ideas on the proposals:

"Ask the community" issue report - I love the idea of providing a link from the issue templates to the discussion forum

💡Feedback on the bug report

  1. Could you make the Prerequisite section informational (not required checkboxes)?
  2. On the "To Reproduce" section, make it optional in case they need assistance recreating the issues
  3. For now, we can exclude the OS and Browser dropdowns
  4. I like the freeform "version" textbox and the fact it is not required

💡User Story template

  1. If you could turn the "user story" template into a combined "Issue or Enhancement" template/form it would be ideal
  2. Change the example text in the title so it's applicable to Issues and Enhancements
  3. For the text area "Is your feature request related to a problem? Please describe.", provide an alternative label such as "Please describe the Issue or Enhancement". (required field)
  4. For the "Describe the solution you'd like" section, I'd suggest calling it "Proposal" or "Solution Proposal" .
  5. I like all the additional fields you have in the form to provide additional context. I also like that they are optional so folks can just fill in what they know to get the conversation rolling

@andresgalante
Copy link
Contributor Author

@dussab The changes are made, you can preview them here. The original PR was based on the template Miner currently has.

Just a thought: "Issue or Enhancement" might be misleading since, as I understand it, an issue is a bug report, and an enhancement is a feature request. A better separation might be "Report a bug" and "Feature request"

@dussab
Copy link
Contributor

dussab commented Nov 9, 2023

Yeah, I can see your point. While I have historically gone with a combined approach to have fewer options for folks to consider, I'd see value in separating them for clarity. Go for it! I love all the other updates!

@andresgalante
Copy link
Contributor Author

andresgalante commented Nov 9, 2023

@dussab it's updated. Thanks for giving it a try, if it doesn't work for contributors or forms become a problem to maintainers feel free to revert it 😬

Preview is here.

Copy link
Contributor

@dussab dussab left a comment

Choose a reason for hiding this comment

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

Thanks for making the updates. Looks great!

@dussab dussab merged commit 65bfb08 into mindersec:main Nov 9, 2023
13 checks passed
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.

3 participants