From 6c0ad37168e3534b8b7584ba749a05f245e0abe3 Mon Sep 17 00:00:00 2001 From: OJ Kwon Date: Thu, 10 Dec 2020 23:31:22 -0800 Subject: [PATCH] docs(issue): update issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 23 ++++++++++++++++++--- .github/ISSUE_TEMPLATE/documentation.md | 21 ------------------- .github/ISSUE_TEMPLATE/feature_request.md | 24 ---------------------- .github/ISSUE_TEMPLATE/support-question.md | 12 ----------- 4 files changed, 20 insertions(+), 60 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/documentation.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/ISSUE_TEMPLATE/support-question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0f772bd72b..615e26e849 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,15 +1,34 @@ --- name: Bug report -about: If rxjs does not behave as expected +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) @@ -17,8 +36,6 @@ A clear and concise description of the behavior. var your => (code) => here; ``` -**Expected behavior** -A clear and concise description of what you expected to happen (or code). **Environment** - Runtime: [e.g. Node v${x}, Chrome v${x}] diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md deleted file mode 100644 index 416f640df7..0000000000 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: Documentation -about: Issues around documentation - ---- - -### Documentation Related To Component: - - - -### Please check those that apply - -- [ ] typo -- [ ] documentation doesn't exist -- [ ] documentation needs clarification -- [ ] error(s) in example -- [ ] needs example - -### Description Of The Issue - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 33ccca8481..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature request -about: Suggest new operator or features - ---- - -## Feature Request - -With pipable operator, RxJS strongly recommends to create new features via pipable function and publish it as user-land module. If this feature request is - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**(If this is new operator request) describe reason it should be core operator** -A clear and concise description of reason it can't be achieved via user-land module. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/support-question.md b/.github/ISSUE_TEMPLATE/support-question.md deleted file mode 100644 index e92a4b4a81..0000000000 --- a/.github/ISSUE_TEMPLATE/support-question.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -name: Support Question -about: "If you have a question, please check out our StackOverflow! " ----We primarily use GitHub as an issue tracker; for usage and support questions, please check out these resources below. Thanks! - ---- - -- StackOverflow: https://stackoverflow.com/questions/tagged/rxjs using the tag `rxjs` -- Also have a look at the readme for more information, possibly can have some answers already: - -* https://github.com/ReactiveX/rxjs/blob/master/README.md -* https://github.com/ReactiveX/rxjs/blob/master/MIGRATION.md