From 13fd9e2e7f1806445ffe8565018680820e9810f4 Mon Sep 17 00:00:00 2001 From: OJ Kwon Date: Sat, 6 Nov 2021 15:24:59 -0700 Subject: [PATCH 1/6] chore(issue): update issue template --- .github/ISSUE_TEMPLATE.md | 21 ------------ .github/ISSUE_TEMPLATE/bug_report.md | 49 --------------------------- .github/ISSUE_TEMPLATE/bug_report.yml | 44 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ 4 files changed, 49 insertions(+), 70 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 784360ede6..0000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,21 +0,0 @@ - - -**RxJS version:** - -**Code to reproduce:** - -**Expected behavior:** - -**Actual behavior:** - -**Additional information:** diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 615e26e849..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -name: Bug report -about: Reporting bugs for rxjs core behavior - ---- - - - -## Bug Report - -**Current Behavior** -A clear and concise description of the behavior. - -**Expected behavior** -A clear and concise description of what you expected to happen (or code). - -**Reproduction** - -** Please provide repro code does not involves framework, or other setups to address this bug is specific to rxjs core ** - -- REPL or Repo link: -(you can use https://stackblitz.com/ to create one to attach here) - -```js -var your => (code) => here; -``` - - -**Environment** -- Runtime: [e.g. Node v${x}, Chrome v${x}] -- RxJS version: -- (If bug is related) Loader, build configuration: [e.g webpack, angular-cli version, config] - -**Possible Solution** - - -**Additional context/Screenshots** -Add any other context about the problem here. If applicable, add screenshots to help explain. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..8fcce50583 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,44 @@ +name: Bug Report +description: Bug report for RxJS core behavior. +body: + - type: textarea + id: description + attributes: + label: Describe the bug + description: | + A clear and concise description of the behavior. + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + description: A clear and concise description of what you expect to happen. + validations: + required: true + - type: textarea + id: code + attributes: + label: Input code + render: typescript + - type: input + id: repro-link + attributes: + label: Link to repro + description: Use [Stackblitz](https://stackblitz.com/) or git repo can reproduce issue + - type: input + id: version + attributes: + label: Version + validations: + required: true + - type: textarea + id: environment + attributes: + label: Environment + placeholder: Version of runtime environment, build configuration, etcs can affect behavior of RxJS. + - type: textarea + id: addition + attributes: + label: Additional context + placeholder: Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..5fbd27ac35 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Questions, request, issues other than Rx core bugs + url: https://github.com/ReactiveX/rxjs/discussions + about: For general discussions, or request please use discussions. From da059d5f2ab0bc5f8790ca750bf85bede4cdb44b Mon Sep 17 00:00:00 2001 From: Ben Lesh Date: Tue, 30 Nov 2021 09:57:08 -0600 Subject: [PATCH 2/6] chore: Use Stackblitz rxjs template --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 8fcce50583..4a2c1381e4 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -25,7 +25,7 @@ body: id: repro-link attributes: label: Link to repro - description: Use [Stackblitz](https://stackblitz.com/) or git repo can reproduce issue + description: Use [Stackblitz](https://stackblitz.com/fork/rxjs) or git repo can reproduce issue - type: input id: version attributes: From 219d2b60b43265dbbc4c079ecdc9c23760c6b0ac Mon Sep 17 00:00:00 2001 From: Ben Lesh Date: Tue, 30 Nov 2021 09:58:21 -0600 Subject: [PATCH 3/6] chore: Tweak label to be more clear --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 4a2c1381e4..001fad13cd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -24,7 +24,7 @@ body: - type: input id: repro-link attributes: - label: Link to repro + label: Reproduction URL description: Use [Stackblitz](https://stackblitz.com/fork/rxjs) or git repo can reproduce issue - type: input id: version From 9359a9fb751227b15e81e857ec8e5900f0be3842 Mon Sep 17 00:00:00 2001 From: Ben Lesh Date: Tue, 30 Nov 2021 10:01:31 -0600 Subject: [PATCH 4/6] chore: Adding clarity to code section label --- .github/ISSUE_TEMPLATE/bug_report.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 001fad13cd..23f6d7a9da 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -19,7 +19,8 @@ body: - type: textarea id: code attributes: - label: Input code + label: Reproduction code + description: Code to create a minimal reproduction. render: typescript - type: input id: repro-link From 20d7b8c5f442f7dc698c0373015e271e97f1ad40 Mon Sep 17 00:00:00 2001 From: Ben Lesh Date: Tue, 30 Nov 2021 10:03:27 -0600 Subject: [PATCH 5/6] chore: Fix issues with the description --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 23f6d7a9da..cae373e674 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -26,7 +26,7 @@ body: id: repro-link attributes: label: Reproduction URL - description: Use [Stackblitz](https://stackblitz.com/fork/rxjs) or git repo can reproduce issue + description: Use [Stackblitz](https://stackblitz.com/fork/rxjs) or a git repo to show a minimal reproduction of the issue. Please also paste the example code in the "Reproduction code" section above. - type: input id: version attributes: From a52893a6d9995790c3c4bf7ef42306b00f0148fc Mon Sep 17 00:00:00 2001 From: Ben Lesh Date: Tue, 30 Nov 2021 10:05:06 -0600 Subject: [PATCH 6/6] chore: Update environment placeholder. --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index cae373e674..10313cbb44 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -37,7 +37,7 @@ body: id: environment attributes: label: Environment - placeholder: Version of runtime environment, build configuration, etcs can affect behavior of RxJS. + placeholder: Version of runtime environment, build configuration, etc, that can affect behavior of RxJS. - type: textarea id: addition attributes: