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 + + + ## Steps to Reproduce + 1. + 2. + 3. + + ## Example + + **Extension Code:** + ```rs + ``` + + **PHP Code:** + ```php + + + ## Use Case + + + ## Example + + 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 + + + ## Example + + **Extension Code:** + ```rs + ``` + + **PHP Code:** + ```php + + +## 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.md` (e.g. `v0.14.md`).