Skip to content

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

Merged
merged 9 commits into from
Feb 23, 2022
Merged

chore: add issue forms #4617

merged 9 commits into from
Feb 23, 2022

Conversation

vladanpaunovic
Copy link
Contributor

Add new Github issue forms to this repository

Copy link
Member

@AbhiPrasad AbhiPrasad left a comment

Choose a reason for hiding this comment

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

🚀

Copy link
Member

@lobsterkatie lobsterkatie left a 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!

Comment on lines +60 to +83
- 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
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- 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.

Copy link
Contributor Author

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.

Comment on lines 1 to 5
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
Copy link
Member

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.

Copy link
Contributor Author

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.
Copy link
Member

Choose a reason for hiding this comment

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

🚀

@github-actions
Copy link
Contributor

github-actions bot commented Feb 23, 2022

size-limit report

Path Base Size (0af57a4) Current Size Change
@sentry/browser - ES5 CDN Bundle (gzipped + minified) 19.7 KB 19.7 KB -0.01% 🔽
@sentry/browser - ES5 CDN Bundle (minified) 63.31 KB 63.31 KB 0%
@sentry/browser - ES6 CDN Bundle (gzipped + minified) 18.37 KB 18.37 KB -0.01% 🔽
@sentry/browser - ES6 CDN Bundle (minified) 56.48 KB 56.48 KB 0%
@sentry/browser - Webpack (gzipped + minified) 22.16 KB 22.16 KB 0%
@sentry/browser - Webpack (minified) 76.18 KB 76.18 KB 0%
@sentry/react - Webpack (gzipped + minified) 22.19 KB 22.19 KB 0%
@sentry/nextjs Client - Webpack (gzipped + minified) 46.33 KB 46.33 KB 0%
@sentry/browser + @sentry/tracing - ES5 CDN Bundle (gzipped + minified) 27.16 KB 27.16 KB +0.01% 🔺

@AbhiPrasad
Copy link
Member

Please rebase this and we can merge!

@vladanpaunovic vladanpaunovic merged commit e13b087 into master Feb 23, 2022
@vladanpaunovic vladanpaunovic deleted the add-issue-forms branch February 23, 2022 13:10
timfish pushed a commit to timfish/sentry-javascript that referenced this pull request Feb 23, 2022
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