Skip to content

Commit e428dda

Browse files
committed
:octocat: issue template guardrails
1 parent b640be2 commit e428dda

File tree

6 files changed

+160
-110
lines changed

6 files changed

+160
-110
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
2+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
3+
4+
name: "Bug report"
5+
description: "You've found a bug? Does the library not behave as expected?"
6+
title: "[BUG] "
7+
labels: ["bug"]
8+
9+
body:
10+
11+
- type: markdown
12+
attributes:
13+
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 have a question or an issue that is not a bug, please go to [the discussions section](../discussions) instead. Thanks!"
14+
15+
- type: textarea
16+
validations:
17+
required: true
18+
attributes:
19+
label: "Issue description"
20+
description: "Please describe the bug or unexpected behaviour, add screenshots to help explain the problem if applicable."
21+
placeholder: "A clear and concise description of the issue"
22+
23+
- type: textarea
24+
validations:
25+
required: true
26+
attributes:
27+
label: "Expected behavior"
28+
description: "Please describe what you expected to happen or how the library should behave in this case."
29+
placeholder: "A clear and concise description of what you expected to happen"
30+
31+
- type: textarea
32+
validations:
33+
required: false
34+
attributes:
35+
label: "Code sample"
36+
description: "If applicable, please add a code sample that reproduces the issue.\nNote: the content of this textarea will be rendered as PHP code!"
37+
placeholder: "PHP code"
38+
render: php
39+
40+
- type: dropdown
41+
id: version
42+
validations:
43+
required: true
44+
attributes:
45+
label: "Library version"
46+
description: "What version of the library are you running?"
47+
options:
48+
- "latest"
49+
- "dev-main"
50+
- "6.x"
51+
- "5.x"
52+
- "4.x"
53+
- "3.x"
54+
- "2.x"
55+
- "1.x"
56+
default: 0
57+
58+
- type: textarea
59+
validations:
60+
required: false
61+
attributes:
62+
label: "Additional context"
63+
description: "Add any other context that might be of use here, e.g. exact library version, PHP Version, operating system, other code snippets..."
64+
65+
- type: markdown
66+
attributes:
67+
value: "Thanks for taking the time to fill out this issue report!"

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 0 additions & 26 deletions
This file was deleted.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
2+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
3+
4+
name: "Documentation"
5+
description: "There's a documentation issue?"
6+
title: "[DOCS] "
7+
labels: ["docs"]
8+
9+
body:
10+
11+
- type: markdown
12+
attributes:
13+
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!"
14+
15+
- type: textarea
16+
validations:
17+
required: true
18+
attributes:
19+
label: "Description"
20+
description: "Please describe the documentation issue or addition."
21+
placeholder: "A clear and concise description of the issue or addition"
22+
23+
- type: textarea
24+
validations:
25+
required: false
26+
attributes:
27+
label: "Proposed change/addition"
28+
description: "If applicable, please add the proposed change here."
29+
placeholder: "The new or changed documentation text"
30+
31+
- type: textarea
32+
validations:
33+
required: false
34+
attributes:
35+
label: "Additional context"
36+
description: "Add any other context here, for example a link to the current documentation or an issue/discussion for reference."
37+
38+
- type: markdown
39+
attributes:
40+
value: "Thanks for taking the time to fill out this issue report!"

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 33 deletions
This file was deleted.
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
2+
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
3+
4+
name: "Feature request"
5+
description: "You have an idea for a new feature?"
6+
title: "[ENHANCEMENT] "
7+
labels: ["enhancement"]
8+
9+
body:
10+
11+
- type: markdown
12+
attributes:
13+
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!"
14+
15+
- type: textarea
16+
validations:
17+
required: true
18+
attributes:
19+
label: "Feature description"
20+
description: "Please describe the requested feature."
21+
placeholder: "A clear and concise description of the requested feature"
22+
23+
- type: textarea
24+
validations:
25+
required: false
26+
attributes:
27+
label: "Code sample"
28+
description: "If applicable, please add a code sample to illustrate the feature.\nNote: the content of this textarea will be rendered as PHP code!"
29+
placeholder: "PHP code"
30+
render: php
31+
32+
- type: textarea
33+
validations:
34+
required: false
35+
attributes:
36+
label: "Additional context"
37+
description: "Add any other context that might be of use here, e.g. other code snippets..."
38+
39+
- type: dropdown
40+
validations:
41+
required: true
42+
id: pr
43+
attributes:
44+
label: "Pull Request"
45+
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."
46+
options:
47+
- ""
48+
- "No - I can't/won't submit a PR"
49+
- "Yes - I will submit a PR"
50+
51+
- type: markdown
52+
attributes:
53+
value: "Thanks for taking the time to fill out this feature request!"

0 commit comments

Comments
 (0)