Skip to content

Add bug report and documentation improvement templates #4811

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/bug-issue.md

This file was deleted.

43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -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
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-improvement.yml
Original file line number Diff line number Diff line change
@@ -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
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/documentation-issue.md

This file was deleted.