Skip to content

Commit 77f7879

Browse files
committed
chore: Set up GitHub Issue Templates
- Add `bug-report.yml` for structured bug reporting. - Include a pre-submission checklist for bug reports, checking issue list and Shopify Liquid compatibility. - Add `feature-request.yml` for structured feature requests. - Include a pre-submission checklist for feature requests, checking the issue list. - Configure `config.yml` to disable blank issues and link to GitHub Discussions for questions. - Remove the deprecated `ISSUE_TEMPLATE.md`.
1 parent 012cc9d commit 77f7879

File tree

4 files changed

+135
-12
lines changed

4 files changed

+135
-12
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Bug Report
2+
description: Report a bug in the Liquid template engine
3+
title: "[BUG] "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the form below to help us understand and fix the issue.
10+
11+
- type: checkboxes
12+
id: checklist
13+
attributes:
14+
label: Pre-submission Checklist
15+
description: Please verify you've completed these steps before submitting
16+
options:
17+
- label: I have searched the [issue list](https://github.com/osteele/liquid/issues) for similar issues
18+
required: true
19+
- label: I have tested my example against Shopify Liquid (not required if the issue is a panic or an error where `IsTemplateError` returns false)
20+
required: false
21+
22+
- type: textarea
23+
id: expected-behavior
24+
attributes:
25+
label: Expected Behavior
26+
description: What did you expect to happen?
27+
placeholder: Describe the expected behavior
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: actual-behavior
33+
attributes:
34+
label: Actual Behavior
35+
description: What actually happened?
36+
placeholder: Describe what actually happened, including any error messages
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: detailed-description
42+
attributes:
43+
label: Detailed Description
44+
description: Provide a detailed description with example code, input data, and steps to reproduce
45+
placeholder: |
46+
Example:
47+
```go
48+
template := `{{ "hello" | upcase }}`
49+
engine := liquid.NewEngine()
50+
out, err := engine.ParseAndRenderString(template, nil)
51+
```
52+
render: markdown
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: possible-solution
58+
attributes:
59+
label: Possible Solution
60+
description: (Optional) Suggest a fix or reason for the bug
61+
placeholder: If you have ideas about what might be causing this or how to fix it, please share
62+
63+
- type: input
64+
id: version
65+
attributes:
66+
label: Version
67+
description: What version of liquid are you using?
68+
placeholder: e.g., v1.2.3 or commit SHA

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Question or Discussion
4+
url: https://github.com/osteele/liquid/discussions
5+
about: For questions or general discussion, please use GitHub Discussions
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[FEATURE] "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for your interest in improving the Liquid template engine! Please describe your feature request below.
10+
11+
- type: checkboxes
12+
id: checklist
13+
attributes:
14+
label: Pre-submission Checklist
15+
description: Please verify you've completed this step before submitting
16+
options:
17+
- label: I have searched the [issue list](https://github.com/osteele/liquid/issues) for similar feature requests
18+
required: true
19+
20+
- type: textarea
21+
id: problem
22+
attributes:
23+
label: Problem Description
24+
description: What problem does this feature solve? Is your feature request related to a problem?
25+
placeholder: I'm frustrated when... / It would be useful to have...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: proposed-solution
31+
attributes:
32+
label: Proposed Solution
33+
description: Describe the solution you'd like
34+
placeholder: |
35+
What should the feature do? How should it work?
36+
37+
Example:
38+
```liquid
39+
{{ variable | new_filter }}
40+
```
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: alternatives
46+
attributes:
47+
label: Alternatives Considered
48+
description: Describe any alternative solutions or features you've considered
49+
placeholder: Have you considered workarounds or other approaches?
50+
51+
- type: textarea
52+
id: shopify-compatibility
53+
attributes:
54+
label: Shopify Liquid Compatibility
55+
description: Does this feature exist in Shopify Liquid? If so, please provide documentation or examples
56+
placeholder: Link to Shopify Liquid docs or describe how it works in Shopify
57+
58+
- type: textarea
59+
id: additional-context
60+
attributes:
61+
label: Additional Context
62+
description: Add any other context, examples, or screenshots about the feature request

0 commit comments

Comments
 (0)