Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 120 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
name: Bug Report
description: Report a bug or unexpected behavior
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out the information below to help us investigate.

- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
placeholder: What went wrong?
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Reproduction
description: Steps to reproduce the behavior, or a link to a minimal reproduction (CodeSandbox, StackBlitz, GitHub repo).
placeholder: |
1. Configure i18n with...
2. Navigate to...
3. See error...
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: What did you expect to happen?
placeholder: What should have happened?
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual behavior
description: What actually happened?
placeholder: What actually happened?
validations:
required: true

- type: input
id: sveltekit-i18n-version
attributes:
label: sveltekit-i18n version
description: What version of sveltekit-i18n are you using?
placeholder: "2.4.2"
validations:
required: true

- type: input
id: sveltekit-version
attributes:
label: SvelteKit version
description: What version of SvelteKit are you using?
placeholder: "2.0.0"
validations:
required: true

- type: input
id: node-version
attributes:
label: Node.js version
description: What version of Node.js are you using?
placeholder: "20.10.0"
validations:
required: true

- type: dropdown
id: adapter
attributes:
label: SvelteKit Adapter
description: Which SvelteKit adapter are you using?
options:
- "@sveltejs/adapter-auto"
- "@sveltejs/adapter-node"
- "@sveltejs/adapter-static"
- "@sveltejs/adapter-vercel"
- "@sveltejs/adapter-netlify"
- "@sveltejs/adapter-cloudflare"
- "Other (specify in additional context)"
validations:
required: true

- type: textarea
id: logs
attributes:
label: Error logs
description: Please paste any relevant error messages or console logs.
render: shell
placeholder: Paste error logs here

- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context about the problem here (browser, operating system, etc.).
placeholder: Any additional information that might help

- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Please confirm the following
options:
- label: I have searched existing issues to avoid duplicates
required: true
- label: I have provided a minimal reproduction (if possible)
required: false
- label: I have checked the [Troubleshooting Guide](https://github.com/sveltekit-i18n/lib/blob/master/docs/TROUBLESHOOTING.md)
required: false

15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
blank_issues_enabled: false
contact_links:
- name: 💬 GitHub Discussions
url: https://github.com/sveltekit-i18n/lib/discussions
about: Ask questions, share ideas, or discuss the project
- name: 📖 Documentation
url: https://github.com/sveltekit-i18n/lib/tree/master/docs
about: Read the complete documentation
- name: 🔧 Troubleshooting Guide
url: https://github.com/sveltekit-i18n/lib/blob/master/docs/TROUBLESHOOTING.md
about: Common issues and solutions
- name: 💡 Examples
url: https://github.com/sveltekit-i18n/lib/tree/master/examples
about: Working example applications

69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Documentation Issue
description: Report an issue with documentation or suggest improvements
title: "[Docs]: "
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
Thanks for helping improve our documentation!

- type: dropdown
id: doc-type
attributes:
label: Documentation type
description: What kind of documentation issue is this?
options:
- "Error or incorrect information"
- "Missing information"
- "Unclear or confusing explanation"
- "Broken link"
- "Typo or grammar"
- "Suggestion for improvement"
- "Other"
validations:
required: true

- type: input
id: location
attributes:
label: Documentation location
description: Which documentation page or file is this about?
placeholder: "docs/GETTING_STARTED.md, README.md, etc."
validations:
required: true

- type: textarea
id: current
attributes:
label: Current documentation
description: What does the current documentation say? (copy/paste or describe)
placeholder: The current docs say...
validations:
required: true

- type: textarea
id: issue
attributes:
label: What's the issue?
description: What's wrong or missing?
placeholder: The issue is...
validations:
required: true

- type: textarea
id: suggestion
attributes:
label: Suggested improvement
description: How should it be changed or what should be added?
placeholder: It should say... or Add section about...
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional context
description: Any other context that might help.
placeholder: Any additional information

92 changes: 92 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
name: Feature Request
description: Suggest a new feature or enhancement
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature! Please provide as much detail as possible.

- type: textarea
id: problem
attributes:
label: Problem statement
description: Is your feature request related to a problem? Please describe what you're trying to achieve.
placeholder: I'm trying to do X but can't because...
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed solution
description: Describe the solution you'd like to see.
placeholder: I would like to be able to...
validations:
required: true

- type: textarea
id: api
attributes:
label: Proposed API (if applicable)
description: If you have ideas about how the API should look, share them here.
placeholder: |
```javascript
const config = {
newFeature: { ... }
};
```
render: markdown

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: Have you tried any workarounds or alternative approaches?
placeholder: I tried X but it didn't work because...

- type: textarea
id: use-case
attributes:
label: Use case
description: Describe your use case. How would this feature benefit you and others?
placeholder: This would help with...
validations:
required: true

- type: dropdown
id: scope
attributes:
label: Which package?
description: Which package would this feature be for?
options:
- "sveltekit-i18n (main lib)"
- "@sveltekit-i18n/base"
- "@sveltekit-i18n/parser-default"
- "@sveltekit-i18n/parser-icu"
- "New parser"
- "Not sure"
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context, screenshots, or examples about the feature request.
placeholder: Any additional information

- type: checkboxes
id: checklist
attributes:
label: Checklist
description: Please confirm the following
options:
- label: I have searched existing issues and discussions to avoid duplicates
required: true
- 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)
required: true
- label: This feature cannot be achieved with current functionality
required: true

43 changes: 43 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## What

<!-- Brief description of the changes made -->

## Why

<!-- Explanation of why this change is needed. Link to related issues if applicable. -->

Fixes #
Relates to #

## How

<!-- How you implemented the changes (if the approach is complex or non-obvious) -->

## Testing

<!-- How you tested the changes. Include test scenarios and results. -->

## Checklist

Before submitting this PR, please ensure:

- [ ] **Tests pass locally** (`npm test`)
- [ ] **Linter passes** (`npm run lint`)
- [ ] **Build succeeds** (`npm run build`)
- [ ] **All commits are atomic** (each commit works independently)
- [ ] **Commits have clear messages** (imperative mood, descriptive)
- [ ] **Branch rebased on latest master** (`git rebase origin/master`)
- [ ] **Documentation updated** (if API or behavior changed)
- [ ] **Examples updated** (if adding new features)

## Additional Notes

<!-- Any additional information that reviewers should know -->

---

<!--
Please read our Contributing Guide before submitting:
https://github.com/sveltekit-i18n/lib/blob/master/CONTRIBUTING.md
-->

Loading