From cdc87221c84a6fd9b28eab672748ac31dbdaff0e Mon Sep 17 00:00:00 2001 From: aelf-lxy Date: Tue, 25 Jun 2024 16:44:14 +0800 Subject: [PATCH] feat: add issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 10 ++++++ .github/ISSUE_TEMPLATE/feature_request.md | 32 ++++++++++++++++++++ 3 files changed, 79 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..50de34d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,37 @@ +--- +name: 👾 Bug Report +about: Report a bug or issue with the project. +title: '' +labels: 'bug' +assignees: '' +--- + +### Description + +A clear and concise description of what the bug is. + +### Steps To Reproduce + +1. Log in... +2. Ensure that... +3. Allow a long period of inactivity to pass... +4. Observe that... +5. Attempt to log in... + +### Current Behavior + +- After the period of inactivity... +- When the user tries to log in using another method... +- This causes a bug due to... + +### Expected Behavior + +- After a long period of inactivity... +- When a user logs in successfully... +- This ensures that only... + +### Environment + +- Platform: PC +- Node: v18.18.0 +- Browser: Chrome 126.0.6478.56 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..6d8a9140 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,10 @@ +blank_issues_enabled: false +issue_template: + - name: 👾 Bug Report + description: Report a bug or issue with the project. + labels: ["bug"] + template: bug_report.md + - name: 💡 Feature Request + description: Create a new ticket for a new feature request. + labels: ["enhancement"] + template: feature_request.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..50059e4e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,32 @@ +--- +name: 💡 Feature Request +about: Create a new ticket for a new feature request +title: '' +labels: 'enhancement' +assignees: '' +--- + +### Expected Behavior + +Describe the expected behavior here. + +### Specifications + +As a `user`, I would like to `action` so that `reason`. + +**Features:** + +- describe feature details here. + +**Development Tasks:** + +- [ ] Task 1 +- [ ] Task 2 + +### Dependencies + +List any dependencies that are required for this feature by providing links to the issues or repositories. + +### References + +List any references that are related to this feature request.