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
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
name: 🐞 Bug Report
description: Tell us about something that's not working the way we (probably) intend.
labels: 'Type: Bug'
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I checked for existing issues https://github.com/getsentry/sentry-javascript/issues
required: true
- label: I reviewed the documentation https://docs.sentry.io/
required: true
- label: I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases
required: true
- type: dropdown
id: type
attributes:
label: How do you use Sentry?
options:
- Sentry Saas (sentry.io)
- Self-hosted/on-premise
validations:
required: true
- type: dropdown
id: package
attributes:
label: Which package are you using?
options:
- sentry/browser
- sentry/nextjs
- sentry/angular
- sentry/ember
- sentry/gatsby
- sentry/integrations
- sentry/node
- sentry/react
- sentry/serverless
- sentry/vue
- sentry/wasm
- sentry/utils
- raven-js
- raven-node (raven for node)
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: Which SDK version?
placeholder: ex. 1.5.2
validations:
required: true
- type: input
id: link-to-sentry
attributes:
label: Link to Sentry event
description: Provide a link to the affected event from your Sentry account
placeholder: https://sentry.io/organizations/sentry/issues/3006590523/?project=6183838
- 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
Comment on lines +62 to +85
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.

- type: markdown
attributes:
value: |-
## Thanks 🙏
validations:
required: false
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,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

30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: 💡 Feature Request
description: Create a feature request for sentry-python SDK.
labels: 'enhancement'
body:
- type: markdown
attributes:
value: Thanks for taking the time to file a feature request! Please fill out this form as completely as possible.
- type: textarea
id: problem
attributes:
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.

🚀

validations:
required: true
- type: textarea
id: expected
attributes:
label: Solution Brainstorm
description: We know you have bright ideas to share ... share away, friend.
placeholder: |-
Add a blender to Sentry.
validations:
required: true
- type: markdown
attributes:
value: |-
## Thanks 🙏
Check our [triage docs](https://open.sentry.io/triage/) for what to expect next.