From 3b47028060dc588deec3680a77c4ec919c6c504c Mon Sep 17 00:00:00 2001 From: "Shishkevich D." <135337715+shishkevichd@users.noreply.github.com> Date: Wed, 23 Apr 2025 14:04:36 +0700 Subject: [PATCH] chore: new templates for issues and pull requests (#2935) * chore: new issue templates * chore: fixing templates * chore: add pull request template also edited bug report * chore: add checklist for question and feat request template * chore: remove title prefix * fix: template title * fix: re-fixing the template title * chore: remove checklist for pull request * chore: remove emojies * fix: elimination of minor defects --- .github/ISSUE_TEMPLATE/bug_report.md | 24 ------- .github/ISSUE_TEMPLATE/bug_report.yaml | 77 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ------ .github/ISSUE_TEMPLATE/feature_request.yaml | 39 +++++++++++ .github/ISSUE_TEMPLATE/question-.md | 10 --- .github/ISSUE_TEMPLATE/question.yaml | 22 ++++++ .github/pull_request_template.yml | 20 ++++++ 7 files changed, 158 insertions(+), 54 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml delete mode 100644 .github/ISSUE_TEMPLATE/question-.md create mode 100644 .github/ISSUE_TEMPLATE/question.yaml create mode 100644 .github/pull_request_template.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 8ce7d9ee..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -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. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Version (please complete the following information):** - - 3X-UI Version : [e.g. 2.3.5] - - Xray Version : [e.g. 1.8.13] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 00000000..71431e8f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,77 @@ +name: Bug report +description: Create a report to help us improve +title: "Bug report" +labels: ["bug"] + +body: + - type: markdown + attributes: + value: | + Thank you for reporting a bug! Please fill out the following information. + + - type: textarea + id: what-happened + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: My problem is... + validations: + required: true + + - type: textarea + id: how-repeat-problem + attributes: + label: How to repeat the problem? + description: Sequence of actions that allow you to reproduce the bug + placeholder: | + 1. Open `Inbounds` page + 2. ... + validations: + required: true + + - type: textarea + id: expected-action + attributes: + label: Expected action + description: What's going to happen + placeholder: Must be... + validations: + required: false + + - type: textarea + id: received-action + attributes: + label: Received action + description: What's really happening + placeholder: It's actually happening... + validations: + required: false + + - type: input + id: xui-version + attributes: + label: 3x-ui Version + description: Which version of 3x-ui are you using? + placeholder: 2.X.X + validations: + required: true + + - type: input + id: xray-version + attributes: + label: Xray-core Version + description: Which version of Xray-core are you using? + placeholder: 2.X.X + validations: + required: false + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Please check all the checkboxes + options: + - label: This bug report is written entirely in English. + required: true + - label: This bug report is new and no one has reported it before me. + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 11fc491e..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' - ---- - -**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/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 00000000..7ffbad7a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,39 @@ +name: Feature request +description: Suggest an idea for this project +title: "Feature request" +labels: ["enhancement"] + +body: + - type: textarea + id: is-related-problem + attributes: + label: Is your feature request related to a problem? + description: A clear and concise description of what the problem is. + placeholder: I'm always frustrated when... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Please check all the checkboxes + options: + - label: This feature report is written entirely in English. + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question-.md b/.github/ISSUE_TEMPLATE/question-.md deleted file mode 100644 index 53acd09f..00000000 --- a/.github/ISSUE_TEMPLATE/question-.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: 'Question ' -about: Describe this issue template's purpose here. -title: '' -labels: question -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/question.yaml b/.github/ISSUE_TEMPLATE/question.yaml new file mode 100644 index 00000000..0021f6bd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yaml @@ -0,0 +1,22 @@ +name: Question +description: Describe this issue template's purpose here. +title: "Question" +labels: ["question"] + +body: + - type: textarea + id: question + attributes: + label: Question + placeholder: I have a question, ..., how can I solve it? + validations: + required: true + + - type: checkboxes + id: checklist + attributes: + label: Checklist + description: Please check all the checkboxes + options: + - label: This question is written entirely in English. + required: true diff --git a/.github/pull_request_template.yml b/.github/pull_request_template.yml new file mode 100644 index 00000000..c7eb8e78 --- /dev/null +++ b/.github/pull_request_template.yml @@ -0,0 +1,20 @@ +## What is the pull request? + + + +## Which part of the application is affected by the change? + +- [ ] Frontend +- [ ] Backend + +## Type of Changes + +- [ ] Bug fix +- [ ] New feature +- [ ] Refactoring +- [ ] Other + +## Screenshots + + + \ No newline at end of file