Skip to content

Commit 62788a5

Browse files
jarda-svobodajarda-svoboda
committed
Add issue templates
1 parent cb8668d commit 62788a5

File tree

4 files changed

+296
-0
lines changed

4 files changed

+296
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
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 information below to help us investigate.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Describe the bug
15+
description: A clear and concise description of what the bug is.
16+
placeholder: What went wrong?
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Reproduction
24+
description: Steps to reproduce the behavior, or a link to a minimal reproduction (CodeSandbox, StackBlitz, GitHub repo).
25+
placeholder: |
26+
1. Configure i18n with...
27+
2. Navigate to...
28+
3. See error...
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected behavior
36+
description: What did you expect to happen?
37+
placeholder: What should have happened?
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: actual
43+
attributes:
44+
label: Actual behavior
45+
description: What actually happened?
46+
placeholder: What actually happened?
47+
validations:
48+
required: true
49+
50+
- type: input
51+
id: sveltekit-i18n-version
52+
attributes:
53+
label: sveltekit-i18n version
54+
description: What version of sveltekit-i18n are you using?
55+
placeholder: "2.4.2"
56+
validations:
57+
required: true
58+
59+
- type: input
60+
id: sveltekit-version
61+
attributes:
62+
label: SvelteKit version
63+
description: What version of SvelteKit are you using?
64+
placeholder: "2.0.0"
65+
validations:
66+
required: true
67+
68+
- type: input
69+
id: node-version
70+
attributes:
71+
label: Node.js version
72+
description: What version of Node.js are you using?
73+
placeholder: "20.10.0"
74+
validations:
75+
required: true
76+
77+
- type: dropdown
78+
id: adapter
79+
attributes:
80+
label: SvelteKit Adapter
81+
description: Which SvelteKit adapter are you using?
82+
options:
83+
- "@sveltejs/adapter-auto"
84+
- "@sveltejs/adapter-node"
85+
- "@sveltejs/adapter-static"
86+
- "@sveltejs/adapter-vercel"
87+
- "@sveltejs/adapter-netlify"
88+
- "@sveltejs/adapter-cloudflare"
89+
- "Other (specify in additional context)"
90+
validations:
91+
required: true
92+
93+
- type: textarea
94+
id: logs
95+
attributes:
96+
label: Error logs
97+
description: Please paste any relevant error messages or console logs.
98+
render: shell
99+
placeholder: Paste error logs here
100+
101+
- type: textarea
102+
id: additional
103+
attributes:
104+
label: Additional context
105+
description: Add any other context about the problem here (browser, operating system, etc.).
106+
placeholder: Any additional information that might help
107+
108+
- type: checkboxes
109+
id: checklist
110+
attributes:
111+
label: Checklist
112+
description: Please confirm the following
113+
options:
114+
- label: I have searched existing issues to avoid duplicates
115+
required: true
116+
- label: I have provided a minimal reproduction (if possible)
117+
required: false
118+
- label: I have checked the [Troubleshooting Guide](https://github.com/sveltekit-i18n/lib/blob/master/docs/TROUBLESHOOTING.md)
119+
required: false
120+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 GitHub Discussions
4+
url: https://github.com/sveltekit-i18n/lib/discussions
5+
about: Ask questions, share ideas, or discuss the project
6+
- name: 📖 Documentation
7+
url: https://github.com/sveltekit-i18n/lib/tree/master/docs
8+
about: Read the complete documentation
9+
- name: 🔧 Troubleshooting Guide
10+
url: https://github.com/sveltekit-i18n/lib/blob/master/docs/TROUBLESHOOTING.md
11+
about: Common issues and solutions
12+
- name: 💡 Examples
13+
url: https://github.com/sveltekit-i18n/lib/tree/master/examples
14+
about: Working example applications
15+

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: Documentation Issue
2+
description: Report an issue with documentation or suggest improvements
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping improve our documentation!
10+
11+
- type: dropdown
12+
id: doc-type
13+
attributes:
14+
label: Documentation type
15+
description: What kind of documentation issue is this?
16+
options:
17+
- "Error or incorrect information"
18+
- "Missing information"
19+
- "Unclear or confusing explanation"
20+
- "Broken link"
21+
- "Typo or grammar"
22+
- "Suggestion for improvement"
23+
- "Other"
24+
validations:
25+
required: true
26+
27+
- type: input
28+
id: location
29+
attributes:
30+
label: Documentation location
31+
description: Which documentation page or file is this about?
32+
placeholder: "docs/GETTING_STARTED.md, README.md, etc."
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: current
38+
attributes:
39+
label: Current documentation
40+
description: What does the current documentation say? (copy/paste or describe)
41+
placeholder: The current docs say...
42+
validations:
43+
required: true
44+
45+
- type: textarea
46+
id: issue
47+
attributes:
48+
label: What's the issue?
49+
description: What's wrong or missing?
50+
placeholder: The issue is...
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
id: suggestion
56+
attributes:
57+
label: Suggested improvement
58+
description: How should it be changed or what should be added?
59+
placeholder: It should say... or Add section about...
60+
validations:
61+
required: true
62+
63+
- type: textarea
64+
id: additional
65+
attributes:
66+
label: Additional context
67+
description: Any other context that might help.
68+
placeholder: Any additional information
69+

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
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 suggesting a new feature! Please provide as much detail as possible.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem statement
15+
description: Is your feature request related to a problem? Please describe what you're trying to achieve.
16+
placeholder: I'm trying to do X but can't because...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed solution
24+
description: Describe the solution you'd like to see.
25+
placeholder: I would like to be able to...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: api
31+
attributes:
32+
label: Proposed API (if applicable)
33+
description: If you have ideas about how the API should look, share them here.
34+
placeholder: |
35+
```javascript
36+
const config = {
37+
newFeature: { ... }
38+
};
39+
```
40+
render: markdown
41+
42+
- type: textarea
43+
id: alternatives
44+
attributes:
45+
label: Alternatives considered
46+
description: Have you tried any workarounds or alternative approaches?
47+
placeholder: I tried X but it didn't work because...
48+
49+
- type: textarea
50+
id: use-case
51+
attributes:
52+
label: Use case
53+
description: Describe your use case. How would this feature benefit you and others?
54+
placeholder: This would help with...
55+
validations:
56+
required: true
57+
58+
- type: dropdown
59+
id: scope
60+
attributes:
61+
label: Which package?
62+
description: Which package would this feature be for?
63+
options:
64+
- "sveltekit-i18n (main lib)"
65+
- "@sveltekit-i18n/base"
66+
- "@sveltekit-i18n/parser-default"
67+
- "@sveltekit-i18n/parser-icu"
68+
- "New parser"
69+
- "Not sure"
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: additional
75+
attributes:
76+
label: Additional context
77+
description: Add any other context, screenshots, or examples about the feature request.
78+
placeholder: Any additional information
79+
80+
- type: checkboxes
81+
id: checklist
82+
attributes:
83+
label: Checklist
84+
description: Please confirm the following
85+
options:
86+
- label: I have searched existing issues and discussions to avoid duplicates
87+
required: true
88+
- label: I have checked the [documentation](https://github.com/sveltekit-i18n/lib/tree/master/docs) and [examples](https://github.com/sveltekit-i18n/lib/tree/master/examples)
89+
required: true
90+
- label: This feature cannot be achieved with current functionality
91+
required: true
92+

0 commit comments

Comments
 (0)