Skip to content

Commit

Permalink
:octocat: foolproof issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
codemasher committed Oct 17, 2024
1 parent 0f69428 commit 0428014
Show file tree
Hide file tree
Showing 5 changed files with 160 additions and 84 deletions.
67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema

name: "Bug report"
description: "You've found a bug? Does the library not behave as expected?"
title: "[BUG] "
labels: ["bug"]

body:

- type: markdown
attributes:
value: "You've found a bug? Does the library not behave as expected?\nPlease help us to improve this project and fill out the following form.\nIf you are unsure whether it is a bug, or you have a question or an issue that is not a bug, please go to [the discussions section](../discussions) instead. Thanks!"

- type: textarea
validations:
required: true
attributes:
label: "Issue description"
description: "Please describe the bug or unexpected behaviour, add screenshots to help explain the problem if applicable."
placeholder: "A clear and concise description of the issue"

- type: textarea
validations:
required: true
attributes:
label: "Expected behavior"
description: "Please describe what you expected to happen or how the library should behave in this case."
placeholder: "A clear and concise description of what you expected to happen"

- type: textarea
validations:
required: false
attributes:
label: "Code sample"
description: "If applicable, please add a code sample that reproduces the issue.\nNote: the content of this textarea will be rendered as PHP code!"
placeholder: "PHP code"
render: php

- type: dropdown
id: version
validations:
required: true
attributes:
label: "Library version"
description: "What version of the library are you running?"
options:
- "latest"
- "dev-main"
- "6.x"
- "5.x"
- "4.x"
- "3.x"
- "2.x"
- "1.x"
default: 0

- type: textarea
validations:
required: false
attributes:
label: "Additional context"
description: "Add any other context that might be of use here, e.g. exact library version, PHP Version, operating system, other code snippets..."

- type: markdown
attributes:
value: "Thanks for taking the time to fill out this issue report!"
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/02-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema

name: "Feature request"
description: "You have an idea for a new feature?"
title: "[ENHANCEMENT] "
labels: ["enhancement"]

body:

- type: markdown
attributes:
value: "You have an idea for a new feature (or improve an existing one)? Great!\nPlease help us to improve this project and fill out the following form.\nIf you have a question or an issue that is not a feature request, please go to [the discussions section](../discussions) instead. Thanks!"

- type: textarea
validations:
required: true
attributes:
label: "Feature description"
description: "Please describe the requested feature."
placeholder: "A clear and concise description of the requested feature"

- type: textarea
validations:
required: false
attributes:
label: "Code sample"
description: "If applicable, please add a code sample to illustrate the feature.\nNote: the content of this textarea will be rendered as PHP code!"
placeholder: "PHP code"
render: php

- type: textarea
validations:
required: false
attributes:
label: "Additional context"
description: "Add any other context that might be of use here, e.g. other code snippets..."

- type: dropdown
validations:
required: true
id: pr
attributes:
label: "Pull Request"
description: "**Are you (the requester) willing to submit a pull request for that feature?**\nA yes will greatly increase the chance that the feature will be added."
options:
- ""
- "No - I can't/won't submit a PR"
- "Yes - I will submit a PR"

- type: markdown
attributes:
value: "Thanks for taking the time to fill out this feature request!"
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/03-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema

name: "Documentation"
description: "There's a documentation issue?"
title: "[DOCS] "
labels: ["docs"]

body:

- type: markdown
attributes:
value: "There's an issue with the documentation or you have a proposal for an addition?\nPlease help us to improve this project and fill out the following form.\nIf you have a question or an issue that has nothing to do with the documentation, please go to [the discussions section](../discussions) instead. Thanks!"

- type: textarea
validations:
required: true
attributes:
label: "Description"
description: "Please describe the documentation issue or addition."
placeholder: "A clear and concise description of the issue or addition"

- type: textarea
validations:
required: false
attributes:
label: "Proposed change/addition"
description: "If applicable, please add the proposed change here."
placeholder: "The new or changed documentation text"

- type: textarea
validations:
required: false
attributes:
label: "Additional context"
description: "Add any other context here, for example a link to the current documentation or an issue/discussion for reference."

- type: markdown
attributes:
value: "Thanks for taking the time to fill out this issue report!"
51 changes: 0 additions & 51 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit 0428014

Please sign in to comment.