Skip to content

Commit 5d91ab0

Browse files
committed
Updated README
1 parent 3aac620 commit 5d91ab0

File tree

11 files changed

+123
-73
lines changed

11 files changed

+123
-73
lines changed

.github/ISSUE_TEMPLATE/01-bug.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: ⚠️️ Bug report
2+
description: Report a bug
3+
title: "[BUG]: "
4+
labels: ["Type: Bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
To report a bug, complete the form below.
10+
- type: input
11+
attributes:
12+
label: Project version
13+
description: Version of this project in which the bug exists
14+
placeholder: vX.X.X
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: Description
20+
description: Detailed description of the bug
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: Expected behavior
26+
description: A summary of what you expected, should this issue not have arisen
27+
- type: textarea
28+
attributes:
29+
label: Possible solution
30+
description: Possible solution/fix to this issue
31+
- type: textarea
32+
attributes:
33+
label: Steps to reproduce
34+
description: Can provide links to a live example, code snippets, screenshots, or simple steps to reproduce this bug
35+
- type: textarea
36+
attributes:
37+
label: Environment
38+
description: Details of the environment which experienced this bug
39+
- type: textarea
40+
attributes:
41+
label: Additional information
42+
description: Additional information/details

.github/ISSUE_TEMPLATE/02-feature.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: 🛠️ Feature request
2+
description: Request a new feature
3+
title: "[FEATURE]: "
4+
labels: ["Type: Feature"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
To request a new feature, complete the form below.
10+
- type: input
11+
attributes:
12+
label: Current project version
13+
description: Latest release of this project to-date
14+
placeholder: vX.X.X
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: Description
20+
description: Description of the proposed feature
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: Scenario/use-case
26+
description: Explain how/when the feature would be helpful
27+
- type: textarea
28+
attributes:
29+
label: Possible solution
30+
description: Possible solution to implement this feature
31+
- type: textarea
32+
attributes:
33+
label: Additional information
34+
description: Additional information/details
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: ❓ Question
2+
description: Ask a question
3+
title: "[QUESTION]: "
4+
labels: ["Type: Question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
To ask a question, complete the form below.
10+
- type: input
11+
attributes:
12+
label: Current project version
13+
description: Latest release of this project to-date
14+
placeholder: vX.X.X
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: Description
20+
description: Description of the question
21+
validations:
22+
required: true

.github/ISSUE_TEMPLATE/04-other.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: 📄 Other
2+
description: All other issues
3+
title: "[OTHER]: "
4+
labels: ["Type: Other"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
To create a new issue, complete the form below.
10+
- type: input
11+
attributes:
12+
label: Project version
13+
description: Version of this project for which this issue applies (if applicable)
14+
placeholder: vX.X.X
15+
- type: textarea
16+
attributes:
17+
label: Description
18+
description: Issue details
19+
validations:
20+
required: true

.github/ISSUE_TEMPLATE/Bug.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/Feature_Request.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/Question.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

.github/SECURITY.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22

33
**PLEASE DO NOT DISCLOSE SECURITY-RELATED ISSUES PUBLICLY**
44

5-
If you discover a security vulnerability, please send an email to [email protected]. All security vulnerabilities will be promptly addressed.
5+
If you discover a security vulnerability, please email [email protected].
6+
All security vulnerabilities will be promptly addressed.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This project is open source and available under the [MIT License](LICENSE).
2121

2222
## Requirements
2323

24-
* PHP `^8.0`
24+
* PHP `^8.0` (Tested up to `8.4`)
2525

2626
## Installation
2727

0 commit comments

Comments
 (0)