Skip to content

Commit 6e91deb

Browse files
authored
Add bug report and documentation improvement templates (#4811)
1 parent b6b305d commit 6e91deb

File tree

4 files changed

+83
-48
lines changed

4 files changed

+83
-48
lines changed

.github/ISSUE_TEMPLATE/bug-issue.md

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

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: "Bug Report"
2+
description: "Report an issue with the PHP documentation"
3+
labels: ["bug"]
4+
5+
body:
6+
- type: input
7+
id: affected-page
8+
attributes:
9+
label: "Affected page"
10+
description: "Provide the URL or file path of the affected documentation page."
11+
placeholder: "e.g., https://www.php.net/manual/en/function.strlen.php"
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: issue-description
17+
attributes:
18+
label: "Issue description"
19+
description: "Describe the bug, including incorrect behavior, broken links, or missing content."
20+
placeholder: "Describe what's wrong or missing on the page."
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: steps-to-reproduce
26+
attributes:
27+
label: "Steps to reproduce"
28+
description: "Explain how to reproduce the issue."
29+
placeholder: |
30+
1. Go to the page
31+
2. Describe the actions
32+
3. Explain the expected behavior
33+
validations:
34+
required: false
35+
36+
- type: textarea
37+
id: suggested-fix
38+
attributes:
39+
label: "Suggested fix"
40+
description: "Provide corrections or relevant references if possible."
41+
placeholder: "e.g., link to correct behavior or suggested text/code."
42+
validations:
43+
required: false
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: "Documentation Improvement"
2+
description: "Suggest an improvement for the PHP documentation"
3+
labels: ["enhancement"]
4+
5+
body:
6+
- type: input
7+
id: affected-page
8+
attributes:
9+
label: "Affected page"
10+
description: "Provide the URL or file path of the documentation to improve."
11+
placeholder: "e.g., https://www.php.net/manual/en/function.strlen.php"
12+
validations:
13+
required: true
14+
15+
- type: textarea
16+
id: current-issue
17+
attributes:
18+
label: "Current issue"
19+
description: "Explain what is wrong or lacking, such as outdated info, missing examples, or unclear explanations."
20+
placeholder: "Explain why the current documentation needs improvement."
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: suggested-improvement
26+
attributes:
27+
label: "Suggested improvement"
28+
description: "Provide updated content, better examples, or clarifications."
29+
placeholder: "Share your proposed improvement."
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: additional-context
35+
attributes:
36+
label: "Additional context (optional)"
37+
description: "Provide references, links, or examples from official or relevant sources."
38+
placeholder: "Optional references or further explanation."
39+
validations:
40+
required: false

.github/ISSUE_TEMPLATE/documentation-issue.md

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

0 commit comments

Comments
 (0)