Skip to content

Commit 315417e

Browse files
CopilotRotzbua
Copilot
and
Rotzbua
committed
Add modern GitHub issue templates with YAML format
- Create bug report template with structured form fields - Create feature request template - Create question/discussion template - Add config.yml for issue template chooser - Update PHP version options to 8.2+ (current requirement) - Update browser list (add Safari, Edge) - Remove old ISSUE_TEMPLATE.md file Co-authored-by: Rotzbua <7337347+Rotzbua@users.noreply.github.com>
1 parent ed69ea6 commit 315417e

File tree

5 files changed

+290
-56
lines changed

5 files changed

+290
-56
lines changed

‎.github/ISSUE_TEMPLATE.md‎

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

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to report a bug! Please fill out the form below to help us understand and resolve the issue.
10+
11+
**Before submitting:**
12+
- Have you read the [README](https://github.com/web-push-libs/web-push-php/blob/master/README.md) entirely?
13+
- Have you searched [existing issues](https://github.com/web-push-libs/web-push-php/issues) to see if this has already been reported?
14+
- Please test in at least two browsers (e.g., Chrome and Firefox) to help diagnose the problem.
15+
16+
- type: checkboxes
17+
id: prerequisites
18+
attributes:
19+
label: Prerequisites
20+
description: Please confirm the following
21+
options:
22+
- label: I have read the [README](https://github.com/web-push-libs/web-push-php/blob/master/README.md) entirely
23+
required: true
24+
- label: I have searched [existing issues](https://github.com/web-push-libs/web-push-php/issues) and this hasn't been reported yet
25+
required: true
26+
- label: I have tested in at least two browsers (e.g., Chrome and Firefox)
27+
required: false
28+
29+
- type: dropdown
30+
id: php-version
31+
attributes:
32+
label: PHP Version
33+
description: Which version of PHP are you using?
34+
options:
35+
- "8.2"
36+
- "8.3"
37+
- "8.4"
38+
- Other (please specify in additional context)
39+
validations:
40+
required: true
41+
42+
- type: input
43+
id: library-version
44+
attributes:
45+
label: web-push-php Version
46+
description: Which version of web-push-php are you using? (e.g., 9.0.0)
47+
placeholder: "9.0.0"
48+
validations:
49+
required: true
50+
51+
- type: dropdown
52+
id: operating-system
53+
attributes:
54+
label: Operating System
55+
description: Which operating system are you using?
56+
options:
57+
- Linux
58+
- Windows
59+
- macOS
60+
- Other (please specify in additional context)
61+
validations:
62+
required: true
63+
64+
- type: checkboxes
65+
id: php-extensions
66+
attributes:
67+
label: PHP Extensions
68+
description: Please confirm that you have the required PHP extensions installed and enabled
69+
options:
70+
- label: curl
71+
- label: mbstring
72+
- label: openssl (with elliptic curve support)
73+
- label: gmp (optional, for performance)
74+
- label: bcmath (optional, for performance)
75+
76+
- type: checkboxes
77+
id: browsers
78+
attributes:
79+
label: Affected Browsers
80+
description: Which browsers are experiencing the issue?
81+
options:
82+
- label: Chrome
83+
- label: Firefox
84+
- label: Firefox for Android
85+
- label: Safari
86+
- label: Safari for iOS
87+
- label: Edge
88+
- label: Opera
89+
- label: Opera for Android
90+
- label: Samsung Internet Browser
91+
- label: Other (please specify in additional context)
92+
93+
- type: textarea
94+
id: browser-versions
95+
attributes:
96+
label: Browser Versions
97+
description: Please specify the browser versions (e.g., Chrome 120, Firefox Beta, Safari 17.2)
98+
placeholder: "Chrome 120, Firefox 121"
99+
validations:
100+
required: false
101+
102+
- type: checkboxes
103+
id: features-used
104+
attributes:
105+
label: Features Used
106+
description: Which features are you using?
107+
options:
108+
- label: VAPID Authentication
109+
- label: Sending with Payload
110+
- label: Automatic Padding
111+
- label: Custom TTL/Urgency/Topic
112+
113+
- type: textarea
114+
id: problem
115+
attributes:
116+
label: Problem Description
117+
description: Please explain what behavior you are seeing
118+
placeholder: Describe the bug or unexpected behavior...
119+
validations:
120+
required: true
121+
122+
- type: textarea
123+
id: expected
124+
attributes:
125+
label: Expected Behavior
126+
description: Please explain what you expected to happen
127+
placeholder: Describe what you expected...
128+
validations:
129+
required: true
130+
131+
- type: textarea
132+
id: reproduce
133+
attributes:
134+
label: Steps to Reproduce
135+
description: |
136+
Please provide a code sample or steps that reproduce the issue.
137+
If there is a repository that reproduces the issue, please provide the link.
138+
placeholder: |
139+
1. Create a subscription with...
140+
2. Send a notification using...
141+
3. Observe that...
142+
validations:
143+
required: true
144+
145+
- type: textarea
146+
id: additional-context
147+
attributes:
148+
label: Additional Context
149+
description: Add any other context about the problem here (error messages, logs, screenshots, etc.)
150+
placeholder: Any additional information...
151+
validations:
152+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 📚 Documentation
4+
url: https://github.com/web-push-libs/web-push-php/blob/master/README.md
5+
about: Please read the documentation before opening an issue
6+
- name: 💬 Discussions
7+
url: https://github.com/web-push-libs/web-push-php/discussions
8+
about: Ask questions and discuss ideas with the community

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for suggesting a new feature! Please fill out the form below to help us understand your idea.
10+
11+
**Before submitting:**
12+
- Have you checked the [README](https://github.com/web-push-libs/web-push-php/blob/master/README.md) to see if this feature already exists?
13+
- Have you searched [existing issues](https://github.com/web-push-libs/web-push-php/issues) to see if this has already been requested?
14+
15+
- type: checkboxes
16+
id: prerequisites
17+
attributes:
18+
label: Prerequisites
19+
description: Please confirm the following
20+
options:
21+
- label: I have read the [README](https://github.com/web-push-libs/web-push-php/blob/master/README.md) and this feature doesn't already exist
22+
required: true
23+
- label: I have searched [existing issues](https://github.com/web-push-libs/web-push-php/issues) and this hasn't been requested yet
24+
required: true
25+
26+
- type: textarea
27+
id: problem
28+
attributes:
29+
label: Problem Statement
30+
description: Is your feature request related to a problem? Please describe.
31+
placeholder: "I'm always frustrated when..."
32+
validations:
33+
required: false
34+
35+
- type: textarea
36+
id: solution
37+
attributes:
38+
label: Proposed Solution
39+
description: Describe the solution you'd like
40+
placeholder: "I would like to be able to..."
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: alternatives
46+
attributes:
47+
label: Alternatives Considered
48+
description: Have you considered any alternative solutions or features?
49+
placeholder: "I've also thought about..."
50+
validations:
51+
required: false
52+
53+
- type: textarea
54+
id: use-case
55+
attributes:
56+
label: Use Case
57+
description: Describe how this feature would benefit you and others
58+
placeholder: "This would help me/others to..."
59+
validations:
60+
required: false
61+
62+
- type: textarea
63+
id: additional-context
64+
attributes:
65+
label: Additional Context
66+
description: Add any other context, screenshots, or examples about the feature request here
67+
placeholder: "Any additional information..."
68+
validations:
69+
required: false

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: ❓ Question
2+
description: Ask a question or start a discussion
3+
title: "[Question]: "
4+
labels: ["question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Have a question? We're here to help!
10+
11+
**Before submitting:**
12+
- Have you checked the [README](https://github.com/web-push-libs/web-push-php/blob/master/README.md)?
13+
- Have you checked the FAQ section in the README?
14+
- Consider using [GitHub Discussions](https://github.com/web-push-libs/web-push-php/discussions) for general questions
15+
16+
- type: checkboxes
17+
id: prerequisites
18+
attributes:
19+
label: Prerequisites
20+
description: Please confirm the following
21+
options:
22+
- label: I have read the [README](https://github.com/web-push-libs/web-push-php/blob/master/README.md) and FAQ
23+
required: true
24+
- label: I have searched [existing issues](https://github.com/web-push-libs/web-push-php/issues) and discussions
25+
required: true
26+
27+
- type: textarea
28+
id: question
29+
attributes:
30+
label: Your Question
31+
description: What would you like to know?
32+
placeholder: "How do I..."
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: context
38+
attributes:
39+
label: Context
40+
description: Provide any relevant context about your question (code samples, what you've tried, etc.)
41+
placeholder: "I'm trying to... and I've attempted..."
42+
validations:
43+
required: false
44+
45+
- type: textarea
46+
id: environment
47+
attributes:
48+
label: Environment (if relevant)
49+
description: |
50+
If your question is environment-specific, please provide details:
51+
- PHP version
52+
- web-push-php version
53+
- Operating system
54+
- Browser(s)
55+
placeholder: |
56+
PHP: 8.3
57+
web-push-php: 9.0.0
58+
OS: Ubuntu 22.04
59+
Browser: Chrome 120
60+
validations:
61+
required: false

0 commit comments

Comments
 (0)