Skip to content

Commit df8a1a9

Browse files
committed
add docs issue type, remove security policy, allow blank issue
1 parent 3c822a1 commit df8a1a9

File tree

3 files changed

+53
-8
lines changed

3 files changed

+53
-8
lines changed

.github/ISSUE_TEMPLATE/1-issue.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
name: "✅ Bug Report"
22
description: File a bug report.
3-
title: "[Bug]: "
3+
title: "[bug]: "
44
labels: ["bug"]
55
body:
66
- type: markdown
77
attributes:
88
value: |
99
## Thank You for taking the time to fill out this bug report! The more information you provide, the faster we can help.
10-
10+
1111
Please remember, a bug report is _not the place to ask questions_. You can
1212
use [Discord](https://discord.gg/YH8Pqja2) for that, or start a topic in [GitHub
1313
Discussions](https://github.com/wpengine/hwptoolkit/discussions).
14-
14+
1515
Also please note that _not all the fields are required_, but _the more information_ you provide, _the better_ we can help you.
1616
1717
- type: textarea

.github/ISSUE_TEMPLATE/2-docs.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: "📒 Documentation Issue"
2+
description: Report an issue with the hwptoolkit documentation.
3+
title: "[docs]: "
4+
labels: ["docs"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## Thank you for helping us improve our documentation!
10+
11+
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.
12+
13+
For feature requests or general questions, please use [GitHub Discussions](https://github.com/wpengine/hwptoolkit/discussions) instead.
14+
15+
- type: textarea
16+
id: issue
17+
attributes:
18+
label: What is the documentation issue?
19+
description: Briefly describe the problem with the documentation
20+
placeholder: "Example: The tutorial for HWP Previews contains outdated configuration steps"
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: context
26+
attributes:
27+
label: Additional context
28+
description: Any extra details that might help us understand the issue
29+
placeholder: "Example: The documentation mentions an old API that was changed in v2.0"
30+
validations:
31+
required: false
32+
33+
- type: input
34+
id: page-link
35+
attributes:
36+
label: Link to the documentation page (if it exists)
37+
description: Provide the URL or file path to the affected documentation
38+
placeholder: "Example: /docs/plugins/hwp-previews/tutorial/index.md"
39+
validations:
40+
required: false
41+
42+
- type: checkboxes
43+
id: terms
44+
attributes:
45+
label: Code of Conduct
46+
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
47+
options:
48+
- label: I agree to follow this project's Code of Conduct
49+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
blank_issues_enabled: false
1+
blank_issues_enabled: true
22
contact_links:
33
- name: Community (Headless WordPress Discord)
44
url: https://faustjs.org/discord
@@ -7,7 +7,3 @@ contact_links:
77
- name: Support / Feature Request / General Help
88
url: https://github.com/wpengine/hwptoolkit/discussions
99
about: Please use our GitHub Discussions for questions, feature ideas, and general help
10-
11-
- name: Security Policy
12-
url: https://github.com/wpengine/hwptoolkit/security/policy
13-
about: Please review our security policy for reporting security vulnerabilities

0 commit comments

Comments
 (0)