-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
chore: add issue forms #4617
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
chore: add issue forms #4617
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some suggestions. Overall I think this could be helpful, though!
- type: textarea | ||
id: repro | ||
attributes: | ||
label: Steps to Reproduce | ||
description: How can we see what you're seeing? Specific is terrific. | ||
placeholder: |- | ||
1. What | ||
2. you | ||
3. did. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected | ||
attributes: | ||
label: Expected Result | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: actual | ||
attributes: | ||
label: Actual Result | ||
description: Logs? Screenshots? Yes, please. | ||
validations: | ||
required: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- type: textarea | |
id: repro | |
attributes: | |
label: Steps to Reproduce | |
description: How can we see what you're seeing? Specific is terrific. | |
placeholder: |- | |
1. What | |
2. you | |
3. did. | |
validations: | |
required: true | |
- type: textarea | |
id: expected | |
attributes: | |
label: Expected Result | |
validations: | |
required: true | |
- type: textarea | |
id: actual | |
attributes: | |
label: Actual Result | |
description: Logs? Screenshots? Yes, please. | |
validations: | |
required: true | |
- type: textarea | |
id: actual | |
attributes: | |
label: Current Behavior | |
description: Logs? Screenshots? Yes, please. | |
validations: | |
required: true | |
- type: textarea | |
id: expected | |
attributes: | |
label: Expected Behavior | |
description: What _should_ be happening? | |
validations: | |
required: true | |
- type: textarea | |
id: repro | |
attributes: | |
label: Steps to Reproduce | |
description: How can we see what you're seeing? Specific is terrific. Repro repos are even better. | |
placeholder: |- | |
1. What | |
2. you | |
3. did. | |
validations: | |
required: true |
I switched the order because IMHO the most salient thing is what's actually going wrong.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Katie.
I would say, all 3 things are important here. It is true that in different scenarios, one is more important than the other. This already follows a known pattern for bug reporting so I would like to keep it as it is.
.github/ISSUE_TEMPLATE/config.yml
Outdated
blank_issues_enabled: false | ||
contact_links: | ||
- name: Ask a question | ||
url: https://github.com/getsentry/sentry-javascript/discussions | ||
about: Ask questions and discuss with other community members |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with Steven here, that for the moment it's just easier to have everything be in one place (issues) rather than two (issues and discussions).
Instead I think we should have a template which matches the bug report but has an open-ended "Describe your issue" text box in place of actual/expected/repro.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool with me. I will point this to issues atm and later make an template with the label question
label: Problem Statement | ||
description: A clear and concise description of what you want and what your use case is. | ||
placeholder: |- | ||
I want to make whirled peas, but Sentry doesn't blend. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
Co-authored-by: Katie Byers <[email protected]>
Co-authored-by: Katie Byers <[email protected]>
Co-authored-by: Katie Byers <[email protected]>
Co-authored-by: Katie Byers <[email protected]>
size-limit report
|
Co-authored-by: Katie Byers <[email protected]>
Co-authored-by: Katie Byers <[email protected]>
Please rebase this and we can merge! |
Add new Github issue forms to this repository