Skip to content

Commit fcd3214

Browse files
XeniraXenira
committed
chore(github): add issue and pr templates
Refs: #455
1 parent 060c8bf commit fcd3214

File tree

5 files changed

+177
-0
lines changed

5 files changed

+177
-0
lines changed

‎.github/ISSUE_TEMPLATE/01_bug_report.yml

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: 🐛 Bug report
2+
description: Something isn't working as expected?
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to report a bug! Please fill out the following sections to help us understand the issue.
9+
- type: textarea
10+
attributes:
11+
label: Description
12+
description: "Please provide a minimal way to reproduce the problem and describe what the expected vs actual behavior is."
13+
value: |
14+
## Description
15+
<!-- Please provide a clear and concise description of the bug. -->
16+
17+
## Steps to Reproduce
18+
1. <!-- Step 1 -->
19+
2. <!-- Step 2 -->
20+
3. <!-- Step 3 -->
21+
22+
## Example
23+
24+
**Extension Code:**
25+
```rs
26+
```
27+
28+
**PHP Code:**
29+
```php
30+
<?php
31+
```
32+
33+
### Actual Behavior
34+
```
35+
```
36+
37+
### Expected Behavior
38+
```
39+
```
40+
validations:
41+
required: true
42+
- type: textarea
43+
attributes:
44+
label: Log Output
45+
description: |
46+
If applicable please provide the full output of the error message or log that you encountered.
47+
If the output is too long, consider uploading it to a pastebin service and linking it here.
48+
render: shell
49+
- type: checkboxes
50+
attributes:
51+
label: Affected Components
52+
description: "Please select all components that are affected by this bug. If you are unsure, leave ALL unchecked."
53+
options:
54+
- label: "ext-php-rs"
55+
- label: "macros"
56+
- label: "cli (cargo-php)"
57+
- type: textarea
58+
attributes:
59+
label: PHP Version
60+
description: |
61+
Please run `php -v` and provide the full output of that command.
62+
placeholder: |
63+
PHP 8.4.8 (cli) (built: Jun 3 2025 16:29:26) (NTS)
64+
Copyright (c) The PHP Group
65+
Zend Engine v4.4.8, Copyright (c) Zend Technologies
66+
with Zend OPcache v8.4.8, Copyright (c), by Zend Technologies
67+
with Xdebug v3.4.4, Copyright (c) 2002-2025, by Derick Rethans
68+
render: plain
69+
validations:
70+
required: true
71+
- type: input
72+
attributes:
73+
label: "`ext-php-rs` Version"
74+
description: "Please provide the exact version of the extension you are using."
75+
placeholder: "0.1.2 or git commit hash"
76+
validations:
77+
required: true
78+
- type: input
79+
attributes:
80+
label: Operating System
81+
description: "The used operating system, if relevant."
82+
placeholder: "Ubuntu 25.04"

‎.github/ISSUE_TEMPLATE/02_feature_request.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: 🚀 Feature request
2+
description: Suggest an idea for this project
3+
labels: ["enhancement"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to suggest a feature! Please fill out the following sections to help us understand your request.
9+
- type: textarea
10+
attributes:
11+
label: Description
12+
description: "Please provide a clear and concise description of the feature you would like to see."
13+
value: |
14+
## Description
15+
<!-- Please provide a clear and concise description of the feature. -->
16+
17+
## Use Case
18+
<!-- Describe how this feature would be used and why it is needed. -->
19+
20+
## Example
21+
<!-- If applicable, provide an example of how this feature could be implemented or used. -->
22+
validations:
23+
required: true
24+
- type: checkboxes
25+
attributes:
26+
label: Additional Context
27+
description: "Please select any additional context that applies to your feature request."
28+
options:
29+
- label: "I can try implementing this feature myself (please assign me to this issue)"

‎.github/ISSUE_TEMPLATE/03_help.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: ⁉️ Help request
2+
description: Need help with something? Ask here!
3+
labels: ["question", "help wanted"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for reaching out for help! Please fill out the following sections to help us understand your issue.
9+
- type: textarea
10+
attributes:
11+
label: Description
12+
description: "Please provide a clear and concise description of the problem you are facing."
13+
value: |
14+
## Description
15+
<!-- Please provide a clear and concise description of the issue. -->
16+
17+
## Example
18+
19+
**Extension Code:**
20+
```rs
21+
```
22+
23+
**PHP Code:**
24+
```php
25+
<?php
26+
```
27+
validations:
28+
required: true
29+
- type: input
30+
attributes:
31+
label: Repository
32+
description: "If this issue is related to one of your repositories, please provide the repository link. (No advertising!)"
33+
placeholder: "https://github.com/user/your-repo"
34+
- type: checkboxes
35+
attributes:
36+
label: I have already tried
37+
description: "Please make sure you have tried the following before asking for help."
38+
options:
39+
- label: "Searching the documentation and guide"
40+
required: true
41+
- label: "Searching existing issues"
42+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## Description
2+
3+
<!--
4+
Describes the changes made in the pull request. This should include:
5+
- A summary of the changes made.
6+
- Relevant or closing issues (e.g. `Fixes #123`).
7+
- Any additional context or information that might be helpful for reviewers.
8+
- If this is a breaking change, please ensure to include a migration guide.
9+
10+
If your PR is related to an issue you can keep this section short and just link the issue.
11+
If you are unsure about something, please ask in the issue or PR. We are always happy to help.
12+
-->
13+
14+
## Checklist
15+
16+
_Check the boxes that apply (put an `x` in the brackets, like `[x]`). You can also check boxes after the PR is created._
17+
18+
- [ ] I have read the [contribution guidelines](../CONTRIBUTING.md).
19+
- [ ] I have added tests that prove my code works as expected.
20+
- [ ] I have added documentation if applicable.
21+
- [ ] I have added a [migration guide](../CONTRIBUTING.md#breaking-changes) if applicable.
22+
23+
:heart: Thank you for your contribution!

‎CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Our documentation is located in the `guide` directory.
5151
If you update functionality, please ensure that the documentation is updated accordingly.
5252

5353
### Breaking Changes
54+
5455
If you make a breaking change, please
5556
If your change is a [breaking change](https://semver.org) a migration guide MUST be included. This
5657
MUST be placed in the `guide/src/migration-guides` directory and named `v<next-version>.md` (e.g. `v0.14.md`).

0 commit comments

Comments
 (0)