Skip to content

Commit

Permalink
feat: add issue template
Browse files Browse the repository at this point in the history
  • Loading branch information
aelf-lxy committed Jun 25, 2024
1 parent 950c593 commit cdc8722
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit cdc8722

Please sign in to comment.