diff --git a/.github/ISSUE_TEMPLATE/1-issue.yml b/.github/ISSUE_TEMPLATE/1-issue.yml index 37b12d29..98e62f5d 100644 --- a/.github/ISSUE_TEMPLATE/1-issue.yml +++ b/.github/ISSUE_TEMPLATE/1-issue.yml @@ -1,17 +1,17 @@ name: "✅ Bug Report" description: File a bug report. -title: "[Bug]: " +title: "[bug]: " labels: ["bug"] body: - type: markdown attributes: value: | ## Thank You for taking the time to fill out this bug report! The more information you provide, the faster we can help. - + Please remember, a bug report is _not the place to ask questions_. You can use [Discord](https://discord.gg/YH8Pqja2) for that, or start a topic in [GitHub Discussions](https://github.com/wpengine/hwptoolkit/discussions). - + Also please note that _not all the fields are required_, but _the more information_ you provide, _the better_ we can help you. - type: textarea diff --git a/.github/ISSUE_TEMPLATE/2-docs.yml b/.github/ISSUE_TEMPLATE/2-docs.yml new file mode 100644 index 00000000..a30c4ad4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-docs.yml @@ -0,0 +1,49 @@ +name: "📒 Documentation Issue" +description: Report an issue with the hwptoolkit documentation. +title: "[docs]: " +labels: ["docs"] +body: + - type: markdown + attributes: + value: | + ## Thank you for helping us improve our documentation! + + Before opening this issue, consider contributing the fix yourself! Check our [Documentation Contribution Guide](https://github.com/wpengine/hwptoolkit/blob/main/CONTRIBUTING.md#writing-documentation) to learn how to edit our docs following the [Diátaxis](https://diataxis.fr/) approach. + + For feature requests or general questions, please use [GitHub Discussions](https://github.com/wpengine/hwptoolkit/discussions) instead. + + - type: textarea + id: issue + attributes: + label: What is the documentation issue? + description: Briefly describe the problem with the documentation + placeholder: "Example: The tutorial for HWP Previews contains outdated configuration steps" + validations: + required: true + + - type: textarea + id: context + attributes: + label: Additional context + description: Any extra details that might help us understand the issue + placeholder: "Example: The documentation mentions an old API that was changed in v2.0" + validations: + required: false + + - type: input + id: page-link + attributes: + label: Link to the documentation page (if it exists) + description: Provide the URL or file path to the affected documentation + placeholder: "Example: /docs/plugins/hwp-previews/tutorial/index.md" + validations: + required: false + + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md). + options: + - label: I agree to follow this project's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index d4b68b31..893caa5d 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: false +blank_issues_enabled: true contact_links: - name: Community (Headless WordPress Discord) url: https://faustjs.org/discord @@ -7,7 +7,3 @@ contact_links: - name: Support / Feature Request / General Help url: https://github.com/wpengine/hwptoolkit/discussions about: Please use our GitHub Discussions for questions, feature ideas, and general help - - - name: Security Policy - url: https://github.com/wpengine/hwptoolkit/security/policy - about: Please review our security policy for reporting security vulnerabilities \ No newline at end of file