Skip to content

Commit d82033f

Browse files
authored
chore: create ISSUE templates and remove deprecated package workflows and templates (#14)
## Summary - Removed deprecated .github directories and workflows from all packages - Cleaned up issue templates, dependabot configs, and CI workflows - Consolidated GitHub configuration at the monorepo root level ## Test plan - [x] Verify no critical workflows were accidentally removed - [x] Confirm monorepo-level workflows still function correctly
1 parent c2a5a2b commit d82033f

File tree

96 files changed

+250
-3139
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+250
-3139
lines changed
Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug in any of the Storyblok SDK packages
3+
title: "🐛 [Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to fill out this bug report!
10+
11+
**🚨 Issues are primarily for bug reports.** For questions, feature requests, and general discussions, please use [GitHub Discussions](https://github.com/storyblok/monoblok/discussions) instead.
12+
13+
Please provide as much detail as possible to help us investigate and fix the issue.
14+
15+
- type: dropdown
16+
id: package
17+
attributes:
18+
label: Package
19+
description: Which Storyblok package is this bug related to?
20+
options:
21+
- "@storyblok/js (Core JavaScript SDK)"
22+
- "@storyblok/js-client (Client SDK)"
23+
- "@storyblok/richtext (Rich Text Renderer)"
24+
- "@storyblok/react (React Integration)"
25+
- "@storyblok/vue (Vue Integration)"
26+
- "@storyblok/nuxt (Nuxt Module)"
27+
- "@storyblok/svelte (Svelte Integration)"
28+
- "@storyblok/astro (Astro Integration)"
29+
- "Multiple packages"
30+
- "Other/Unknown"
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: bug-description
36+
attributes:
37+
label: Bug Description
38+
description: A clear and concise description of what the bug is
39+
placeholder: Describe the bug...
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: reproduction
45+
attributes:
46+
label: Steps to Reproduce
47+
description: Steps to reproduce the behavior
48+
placeholder: |
49+
1. Initialize Storyblok with...
50+
2. Call method...
51+
3. See error...
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: expected
57+
attributes:
58+
label: Expected Behavior
59+
description: A clear and concise description of what you expected to happen
60+
placeholder: What should have happened?
61+
validations:
62+
required: true
63+
64+
- type: textarea
65+
id: actual
66+
attributes:
67+
label: Actual Behavior
68+
description: A clear and concise description of what actually happened
69+
placeholder: What actually happened?
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: code-sample
75+
attributes:
76+
label: Code Sample
77+
description: If applicable, add a minimal code sample that reproduces the issue
78+
render: javascript
79+
placeholder: |
80+
// Your code here
81+
import { storyblokInit } from '@storyblok/js'
82+
83+
// ...
84+
85+
- type: textarea
86+
id: environment
87+
attributes:
88+
label: Environment
89+
description: |
90+
Please run the following command in your project directory and paste the output:
91+
92+
```
93+
npx envinfo --system --npmPackages '{react,vue,svelte,astro,next,nuxt,@storyblok/*,storyblok}' --binaries --browsers
94+
```
95+
render: shell
96+
placeholder: Paste the output of the envinfo command here...
97+
validations:
98+
required: true
99+
100+
- type: textarea
101+
id: logs
102+
attributes:
103+
label: Error Logs
104+
description: If applicable, add any error messages or logs
105+
render: shell
106+
placeholder: Paste any error messages here...
107+
108+
- type: textarea
109+
id: additional-context
110+
attributes:
111+
label: Additional Context
112+
description: Add any other context about the problem here (screenshots, related issues, etc.)
113+
placeholder: Any additional information that might help...
114+
115+

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 💬 GitHub Discussions
4+
url: https://github.com/storyblok/monoblok/discussions
5+
about: Ask questions, request features, and discuss ideas with the community - preferred for most topics!
6+
- name: 🚀 Feature Requests & Ideas
7+
url: https://github.com/storyblok/monoblok/discussions/categories/ideas
8+
about: Share feature requests and enhancement ideas in our Ideas discussion category
9+
- name: ❓ Questions & Help
10+
url: https://github.com/storyblok/monoblok/discussions/categories/q-a
11+
about: Get help with implementation questions and usage in our Q&A discussion category
12+
- name: 🌟 Storyblok Official Support
13+
url: https://www.storyblok.com/support
14+
about: Get official support from the Storyblok team for account and service-related issues
15+
- name: 💬 Community Discord
16+
url: https://www.storyblok.com/join-discord
17+
about: Join the Storyblok community on Discord for real-time discussions and help
18+
- name: 📖 Storyblok Documentation
19+
url: https://www.storyblok.com/docs
20+
about: Browse the official Storyblok documentation and guides
Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
name: 📚 Documentation Issue
2+
description: Report an issue with documentation, examples, or guides
3+
title: "[Docs]: "
4+
labels: ["documentation", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for helping us improve our documentation!
10+
11+
**💡 For documentation suggestions and general discussions about docs, consider using [GitHub Discussions](https://github.com/storyblok/monoblok/discussions).** This issue template is best for specific documentation bugs or errors.
12+
13+
Please provide details about the documentation issue you've found.
14+
15+
- type: dropdown
16+
id: doc-type
17+
attributes:
18+
label: Documentation Type
19+
description: What type of documentation is this issue related to?
20+
options:
21+
- "Package README"
22+
- "API Documentation"
23+
- "Code Examples"
24+
- "Migration Guide"
25+
- "Getting Started Guide"
26+
- "Integration Guide"
27+
- "TypeScript Definitions"
28+
- "Playground/Demo"
29+
- "Contributing Guide"
30+
- "Other"
31+
validations:
32+
required: true
33+
34+
- type: dropdown
35+
id: package
36+
attributes:
37+
label: Package
38+
description: Which Storyblok package is this documentation related to?
39+
options:
40+
- "@storyblok/js (Core JavaScript SDK)"
41+
- "@storyblok/js-client (Client SDK)"
42+
- "@storyblok/richtext (Rich Text Renderer)"
43+
- "@storyblok/react (React Integration)"
44+
- "@storyblok/vue (Vue Integration)"
45+
- "@storyblok/nuxt (Nuxt Module)"
46+
- "@storyblok/svelte (Svelte Integration)"
47+
- "@storyblok/astro (Astro Integration)"
48+
- "Multiple packages"
49+
- "Repository-wide documentation"
50+
validations:
51+
required: true
52+
53+
- type: dropdown
54+
id: issue-type
55+
attributes:
56+
label: Issue Type
57+
description: What kind of documentation issue is this?
58+
options:
59+
- "Missing documentation"
60+
- "Incorrect information"
61+
- "Outdated information"
62+
- "Unclear/confusing explanation"
63+
- "Broken example/code"
64+
- "Typo/grammar error"
65+
- "Missing example"
66+
- "Broken link"
67+
- "Other"
68+
validations:
69+
required: true
70+
71+
- type: input
72+
id: location
73+
attributes:
74+
label: Documentation Location
75+
description: Where is this documentation located? (URL, file path, or section name)
76+
placeholder: "e.g., packages/react/README.md, https://github.com/storyblok/monoblok/..."
77+
validations:
78+
required: true
79+
80+
- type: textarea
81+
id: description
82+
attributes:
83+
label: Issue Description
84+
description: Describe the documentation issue in detail
85+
placeholder: "The documentation states... but it should..."
86+
validations:
87+
required: true
88+
89+
- type: textarea
90+
id: current-content
91+
attributes:
92+
label: Current Content
93+
description: If applicable, copy the current documentation content that needs to be fixed
94+
render: markdown
95+
placeholder: "Current documentation content..."
96+
97+
- type: textarea
98+
id: suggested-content
99+
attributes:
100+
label: Suggested Improvement
101+
description: How do you think this should be documented instead?
102+
render: markdown
103+
placeholder: "Suggested documentation content..."
104+
105+
- type: textarea
106+
id: context
107+
attributes:
108+
label: Additional Context
109+
description: Any additional context that would help improve the documentation
110+
placeholder: |
111+
- What were you trying to accomplish?
112+
- What was confusing?
113+
- What would have helped you understand better?
114+
115+

packages/astro/.github/ISSUE_TEMPLATE/config.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

packages/astro/.github/ISSUE_TEMPLATE/issue.bug.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

packages/astro/.github/ISSUE_TEMPLATE/issue.bug.yml

Lines changed: 0 additions & 68 deletions
This file was deleted.

packages/astro/.github/ISSUE_TEMPLATE/issue.fr.yml

Lines changed: 0 additions & 40 deletions
This file was deleted.

0 commit comments

Comments
 (0)