1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-23 23:32:18 +01:00

Add bug report and documentation improvement templates (#4811)

This commit is contained in:
Luffy
2025-08-16 17:52:40 +08:00
committed by GitHub
parent b6b305d2e0
commit 6e91deb645
4 changed files with 83 additions and 48 deletions

View File

@@ -1,25 +0,0 @@
---
name: "Bug Report"
about: "Report an issue with the PHP documentation"
title: "Issue with ..."
labels: "bug"
assignees: ""
---
**Affected page**
_(Provide the URL or file path of the affected documentation page.)_
**Issue description**
_(Describe the bug, including incorrect behavior, broken links, or missing content.)_
**Steps to reproduce**
1. Go to _(page URL)_
2. _(Describe the actions leading to the issue)_
3. _(Explain the expected behavior)_
**Suggested fix**
_(Provide corrections or relevant references if possible.)_

43
.github/ISSUE_TEMPLATE/bug-report.yml vendored Normal file
View File

@@ -0,0 +1,43 @@
name: "Bug Report"
description: "Report an issue with the PHP documentation"
labels: ["bug"]
body:
- type: input
id: affected-page
attributes:
label: "Affected page"
description: "Provide the URL or file path of the affected documentation page."
placeholder: "e.g., https://www.php.net/manual/en/function.strlen.php"
validations:
required: true
- type: textarea
id: issue-description
attributes:
label: "Issue description"
description: "Describe the bug, including incorrect behavior, broken links, or missing content."
placeholder: "Describe what's wrong or missing on the page."
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: "Steps to reproduce"
description: "Explain how to reproduce the issue."
placeholder: |
1. Go to the page
2. Describe the actions
3. Explain the expected behavior
validations:
required: false
- type: textarea
id: suggested-fix
attributes:
label: "Suggested fix"
description: "Provide corrections or relevant references if possible."
placeholder: "e.g., link to correct behavior or suggested text/code."
validations:
required: false

View File

@@ -0,0 +1,40 @@
name: "Documentation Improvement"
description: "Suggest an improvement for the PHP documentation"
labels: ["enhancement"]
body:
- type: input
id: affected-page
attributes:
label: "Affected page"
description: "Provide the URL or file path of the documentation to improve."
placeholder: "e.g., https://www.php.net/manual/en/function.strlen.php"
validations:
required: true
- type: textarea
id: current-issue
attributes:
label: "Current issue"
description: "Explain what is wrong or lacking, such as outdated info, missing examples, or unclear explanations."
placeholder: "Explain why the current documentation needs improvement."
validations:
required: true
- type: textarea
id: suggested-improvement
attributes:
label: "Suggested improvement"
description: "Provide updated content, better examples, or clarifications."
placeholder: "Share your proposed improvement."
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: "Additional context (optional)"
description: "Provide references, links, or examples from official or relevant sources."
placeholder: "Optional references or further explanation."
validations:
required: false

View File

@@ -1,23 +0,0 @@
---
name: "Documentation Improvement"
about: "Suggest an improvement for the PHP documentation"
title: "Improve ..."
labels: "enhancement"
assignees: ""
---
**Affected page**
_(Provide the URL or file path of the documentation to improve.)_
**Current issue**
_(Explain why the content could be improved, e.g., outdated information, missing examples, lack of clarity.)_
**Suggested improvement**
_(Provide updated content, code snippets, or explanations that could enhance the documentation.)_
**Additional context**
_(Optional: Provide any references or examples from official sources.)_