WIP: sdk issue form template #200
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| name: Bug Report | ||
| description: File a bug report | ||
| title: "[Bug]: " | ||
| labels: ["bug", "triage"] | ||
| body: | ||
| - type: input | ||
| id: library-version | ||
| attributes: | ||
| label: Library version | ||
| description: What version of the library are you using? | ||
| placeholder: ex. v1.2.21 | ||
| validations: | ||
| required: true | ||
| # Can remove this field for most SDKs, but useful for JS | ||
|
There was a problem hiding this comment. Honestly I think this wouldn't even be useful for JS (and certainly not for js v2 😄). I would suggest replacing this with a "Which platform are you experiencing this issue on" (runtime version, browser/react-native/nodejs, etc) which would probably be useful for every SDK. |
||
| - type: input | ||
| id: library-package | ||
| attributes: | ||
| label: Library package | ||
| description: What package are you using within the library? | ||
| placeholder: e.g. Callbacks, promises | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: what-happened | ||
| attributes: | ||
| label: What happened? | ||
| description: What went wrong? Tell us what you see! | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected-behaviour | ||
| attributes: | ||
| label: What did you expect to happen? | ||
| description: If things were working as you'd expect, what would have you seen instead? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
|
There was a problem hiding this comment. My personal preference would be to merge these two fields into an "additional information" field which suggests sharing a minimal repro or debug logs |
||
| id: reproduction | ||
| attributes: | ||
| label: Minimal reproduction code | ||
| description: It would be really helpful if you could provide us with some minimal code that reproduces the issue. Please make sure you remove any sensitive data such as your Ably API key(s)! | ||
| render: shell | ||
| - type: textarea | ||
| id: logs | ||
| attributes: | ||
| label: Log output | ||
| description: If possible, please provide us with verbose logs from the SDK related to the issue. Again, make sure you remove any sensitive data! | ||
| render: shell | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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'm not against using the "triage" label but if we're gonna go for that we ought to add it to https://github.com/ably/engineering/blob/main/sdk/github.md#labels and document some process about how we use it - i guess that would just be "remove the label once the bug is prioritised"