From e30f294bbc73da32638a2eae20c70f352e1f1b9b Mon Sep 17 00:00:00 2001
From: Xenira <1288524+Xenira@users.noreply.github.com>
Date: Thu, 3 Jul 2025 21:37:10 +0200
Subject: [PATCH] chore(github): add issue and pr templates

Refs: #455
---
 .github/ISSUE_TEMPLATE/01_bug_report.yml      | 82 +++++++++++++++++++
 .github/ISSUE_TEMPLATE/02_feature_request.yml | 29 +++++++
 .github/ISSUE_TEMPLATE/03_help.yml            | 42 ++++++++++
 .github/PULL_REQUEST_TEMPLATE.md              | 23 ++++++
 CONTRIBUTING.md                               |  1 +
 5 files changed, 177 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/01_bug_report.yml
 create mode 100644 .github/ISSUE_TEMPLATE/02_feature_request.yml
 create mode 100644 .github/ISSUE_TEMPLATE/03_help.yml
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.yml b/.github/ISSUE_TEMPLATE/01_bug_report.yml
new file mode 100644
index 000000000..46071e022
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/01_bug_report.yml
@@ -0,0 +1,82 @@
+name: 🐛 Bug report
+description: Something isn't working as expected?
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug! Please fill out the following sections to help us understand the issue.
+  - type: textarea
+    attributes:
+      label: Description
+      description: "Please provide a minimal way to reproduce the problem and describe what the expected vs actual behavior is."
+      value: |
+        ## Description
+        <!-- Please provide a clear and concise description of the bug. -->
+
+        ## Steps to Reproduce
+        1. <!-- Step 1 -->
+        2. <!-- Step 2 -->
+        3. <!-- Step 3 -->
+
+        ## Example
+
+        **Extension Code:**
+        ```rs
+        ```
+
+        **PHP Code:**
+        ```php
+        <?php
+        ```
+
+        ### Actual Behavior
+        ```
+        ```
+
+        ### Expected Behavior
+        ```
+        ```
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Log Output
+      description: |
+        If applicable please provide the full output of the error message or log that you encountered.
+        If the output is too long, consider uploading it to a pastebin service and linking it here.
+      render: shell
+  - type: checkboxes
+    attributes:
+      label: Affected Components
+      description: "Please select all components that are affected by this bug. If you are unsure, leave ALL unchecked."
+      options:
+        - label: "ext-php-rs"
+        - label: "macros"
+        - label: "cli (cargo-php)"
+  - type: textarea
+    attributes:
+      label: PHP Version
+      description: |
+        Please run `php -v` and provide the full output of that command.
+      placeholder: |
+        PHP 8.4.8 (cli) (built: Jun  3 2025 16:29:26) (NTS)
+        Copyright (c) The PHP Group
+        Zend Engine v4.4.8, Copyright (c) Zend Technologies
+            with Zend OPcache v8.4.8, Copyright (c), by Zend Technologies
+            with Xdebug v3.4.4, Copyright (c) 2002-2025, by Derick Rethans
+      render: plain
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: "`ext-php-rs` Version"
+      description: "Please provide the exact version of the extension you are using."
+      placeholder: "0.1.2 or git commit hash"
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Operating System
+      description: "The used operating system, if relevant."
+      placeholder: "Ubuntu 25.04"
diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.yml b/.github/ISSUE_TEMPLATE/02_feature_request.yml
new file mode 100644
index 000000000..ab8a5f0a6
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/02_feature_request.yml
@@ -0,0 +1,29 @@
+name: 🚀 Feature request
+description: Suggest an idea for this project
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to suggest a feature! Please fill out the following sections to help us understand your request.
+  - type: textarea
+    attributes:
+      label: Description
+      description: "Please provide a clear and concise description of the feature you would like to see."
+      value: |
+        ## Description
+        <!-- Please provide a clear and concise description of the feature. -->
+
+        ## Use Case
+        <!-- Describe how this feature would be used and why it is needed. -->
+
+        ## Example
+        <!-- If applicable, provide an example of how this feature could be implemented or used. -->
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Additional Context
+      description: "Please select any additional context that applies to your feature request."
+      options:
+        - label: "I can try implementing this feature myself (please assign me to this issue)"
diff --git a/.github/ISSUE_TEMPLATE/03_help.yml b/.github/ISSUE_TEMPLATE/03_help.yml
new file mode 100644
index 000000000..bdafe7a9a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/03_help.yml
@@ -0,0 +1,42 @@
+name: ⁉️ Help request
+description: Need help with something? Ask here!
+labels: ["question", "help wanted"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for reaching out for help! Please fill out the following sections to help us understand your issue.
+  - type: textarea
+    attributes:
+      label: Description
+      description: "Please provide a clear and concise description of the problem you are facing."
+      value: |
+        ## Description
+        <!-- Please provide a clear and concise description of the issue. -->
+
+        ## Example
+
+        **Extension Code:**
+        ```rs
+        ```
+
+        **PHP Code:**
+        ```php
+        <?php
+        ```
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Repository
+      description: "If this issue is related to one of your repositories, please provide the repository link. (No advertising!)"
+      placeholder: "https://github.com/user/your-repo"
+  - type: checkboxes
+    attributes:
+      label: I have already tried
+      description: "Please make sure you have tried the following before asking for help."
+      options:
+        - label: "Searching the documentation and guide"
+          required: true
+        - label: "Searching existing issues"
+          required: true
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 000000000..90ae6e829
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,23 @@
+## Description
+
+<!--
+Describes the changes made in the pull request. This should include:
+- A summary of the changes made.
+- Relevant or closing issues (e.g. `Fixes #123`).
+- Any additional context or information that might be helpful for reviewers.
+- If this is a breaking change, please ensure to include a migration guide.
+
+If your PR is related to an issue you can keep this section short and just link the issue.
+If you are unsure about something, please ask in the issue or PR. We are always happy to help.
+-->
+
+## Checklist
+
+_Check the boxes that apply (put an `x` in the brackets, like `[x]`). You can also check boxes after the PR is created._
+
+- [ ] I have read the [contribution guidelines](../CONTRIBUTING.md).
+- [ ] I have added tests that prove my code works as expected.
+- [ ] I have added documentation if applicable.
+- [ ] I have added a [migration guide](../CONTRIBUTING.md#breaking-changes) if applicable.
+
+:heart: Thank you for your contribution!
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8b180ad23..7a19c2026 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -51,6 +51,7 @@ Our documentation is located in the `guide` directory.
 If you update functionality, please ensure that the documentation is updated accordingly.
 
 ### Breaking Changes
+
 If you make a breaking change, please
 If your change is a [breaking change](https://semver.org) a migration guide MUST be included. This
 MUST be placed in the `guide/src/migration-guides` directory and named `v<next-version>.md` (e.g. `v0.14.md`).