From 5ee4481f7a8771dbb9abb3044d149d830bdecfa2 Mon Sep 17 00:00:00 2001 From: Andy Ford Date: Mon, 15 May 2023 09:33:35 +0100 Subject: [PATCH 1/2] WIP: sdk issue form template --- templates/sdk-github-issue-template.yaml | 48 ++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 templates/sdk-github-issue-template.yaml diff --git a/templates/sdk-github-issue-template.yaml b/templates/sdk-github-issue-template.yaml new file mode 100644 index 00000000..a30733b1 --- /dev/null +++ b/templates/sdk-github-issue-template.yaml @@ -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 + - 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 + 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 \ No newline at end of file From fdefe2ba666e085c5f2e5c234962e763839cb22e Mon Sep 17 00:00:00 2001 From: Andy Ford Date: Mon, 15 May 2023 09:34:54 +0100 Subject: [PATCH 2/2] Newline EOF --- templates/sdk-github-issue-template.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/sdk-github-issue-template.yaml b/templates/sdk-github-issue-template.yaml index a30733b1..86da85a1 100644 --- a/templates/sdk-github-issue-template.yaml +++ b/templates/sdk-github-issue-template.yaml @@ -45,4 +45,4 @@ body: 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 \ No newline at end of file + render: shell