From 42bd4a9fb88279bb1c281c801848d8a03b00e7ed Mon Sep 17 00:00:00 2001 From: winlin Date: Tue, 26 Sep 2023 09:30:40 +0800 Subject: [PATCH] Update the ISSUE TEMPALTE. --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 ++++++++ .github/issue_template.md | 65 ----------------------- .github/pull_request_template.md | 5 -- 4 files changed, 53 insertions(+), 70 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/issue_template.md delete mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..7bce38f63 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Version** +Desribe your SRS Server version here. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..b07a11b29 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: feature +assignees: '' + +--- + +**What is the business background? Please provide a description.** +Who are the users? How do they utilize this feature? What problem does this feature address? + +**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. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index 053c08b1c..000000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -> Note: Please read FAQ before file an issue, see #2716 - -## Description - -Please description your issue here - -1. SRS Version: x.x.x - -2. SRS Log: - -``` -xxxxxxxxxxxx -xxxxxxxxxxxx -xxxxxxxxxxxx -``` - -3. SRS Config: - -``` -xxxxxxxxxxxx -xxxxxxxxxxxx -xxxxxxxxxxxx -``` - -## Replay - -Please describe how to replay the bug? - -Step 1: xxxxxx - -``` -xxxxxxxxxxxx -xxxxxxxxxxxx -xxxxxxxxxxxx -``` - -Step 2: xxxxxx - -``` -xxxxxxxxxxxx -xxxxxxxxxxxx -xxxxxxxxxxxx -``` - -Step 3: xxxxxx - -``` -xxxxxxxxxxxx -xxxxxxxxxxxx -xxxxxxxxxxxx -``` - -## Expect - -Please describe your expectation. - diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index 37011bfdb..000000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,5 +0,0 @@ -Please describe the summary for this PR. - -1. Add more details about this PR. -1. Add more details about this PR. -1. Add more details about this PR.