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

WIP: sdk issue form template #200

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

WIP: sdk issue form template #200

wants to merge 2 commits into from

Conversation

AndyTWF
Copy link
Contributor

@AndyTWF AndyTWF commented May 15, 2023

No description provided.

placeholder: ex. v1.2.21
validations:
required: true
# Can remove this field for most SDKs, but useful for JS
Copy link
Member

Choose a reason for hiding this comment

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

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.

name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
Copy link
Member

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"

description: If things were working as you'd expect, what would have you seen instead?
validations:
required: true
- type: textarea
Copy link
Member

Choose a reason for hiding this comment

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

My personal preference would be to merge these two fields into an "additional information" field which suggests sharing a minimal repro or debug logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants