Skip to content

Commit 01e5eb0

Browse files
haydenbleaselhaydenbleasel
authored
Community + Publishing Workflow (#35)
* Scaffold changesets * Copy AI SDK config * Update config * Create tender-toes-study.md * Create CONTRIBUTING.md * Create SECURITY.md * Create CODE_OF_CONDUCT.md * Create issue and PR templates
1 parent 6093353 commit 01e5eb0

File tree

18 files changed

+1556
-5
lines changed

18 files changed

+1556
-5
lines changed

‎.changeset/README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changesets
2+
3+
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
4+
with multi-package repos, or single-package repos to help you version and publish your code. You can
5+
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
6+
7+
We have a quick list of common questions to get you started engaging with this project in
8+
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

‎.changeset/config.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"commit": false,
5+
"fixed": [],
6+
"linked": [],
7+
"access": "public",
8+
"baseBranch": "main",
9+
"updateInternalDependencies": "patch",
10+
"ignore": []
11+
}

‎.changeset/tender-toes-study.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"streamdown": patch
3+
---
4+
5+
Add Publishing CI Pipeline

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior in Streamdown
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report this bug! Please fill out the information below to help us understand and fix the issue.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of what the bug is.
16+
placeholder: Describe the bug...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Import Streamdown with '...'
27+
2. Pass markdown content '...'
28+
3. Render component with '...'
29+
4. See error
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: expected
35+
attributes:
36+
label: Expected Behavior
37+
description: What you expected to happen
38+
placeholder: Describe what should happen...
39+
validations:
40+
required: true
41+
42+
- type: textarea
43+
id: actual
44+
attributes:
45+
label: Actual Behavior
46+
description: What actually happened
47+
placeholder: Describe what actually happened...
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: code-sample
53+
attributes:
54+
label: Code Sample
55+
description: If applicable, add a minimal code sample to help reproduce the issue
56+
render: tsx
57+
placeholder: |
58+
import { Streamdown } from 'streamdown';
59+
60+
// Your code here...
61+
62+
- type: input
63+
id: version
64+
attributes:
65+
label: Streamdown Version
66+
description: What version of Streamdown are you using?
67+
placeholder: e.g., 1.1.1
68+
validations:
69+
required: true
70+
71+
- type: input
72+
id: react-version
73+
attributes:
74+
label: React Version
75+
description: What version of React are you using?
76+
placeholder: e.g., 18.2.0 or 19.0.0
77+
validations:
78+
required: true
79+
80+
- type: input
81+
id: node-version
82+
attributes:
83+
label: Node.js Version
84+
description: What version of Node.js are you using?
85+
placeholder: e.g., 20.10.0
86+
87+
- type: dropdown
88+
id: browsers
89+
attributes:
90+
label: Browser(s)
91+
description: What browsers are you seeing the problem on?
92+
multiple: true
93+
options:
94+
- Chrome
95+
- Firefox
96+
- Safari
97+
- Edge
98+
- Other
99+
- Not applicable (Node.js)
100+
101+
- type: dropdown
102+
id: os
103+
attributes:
104+
label: Operating System
105+
options:
106+
- macOS
107+
- Windows
108+
- Linux
109+
- iOS
110+
- Android
111+
- Other
112+
113+
- type: textarea
114+
id: additional
115+
attributes:
116+
label: Additional Context
117+
description: Add any other context about the problem here (e.g., screenshots, error messages, console logs)
118+
placeholder: Any additional information...

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Documentation
4+
url: https://streamdown.ai
5+
about: Check out the documentation for usage examples and API reference
6+
- name: GitHub Discussions
7+
url: https://github.com/vercel/streamdown/discussions
8+
about: Ask questions and discuss ideas with the community
9+
- name: Security Vulnerability
10+
url: https://github.com/vercel/streamdown/security/advisories/new
11+
about: Please report security vulnerabilities privately

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement for Streamdown
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a feature! Please provide as much detail as possible to help us understand your request.
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.
16+
placeholder: I'm always frustrated when...
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
25+
placeholder: I would like Streamdown to...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Describe any alternative solutions or features you've considered
34+
placeholder: I've also considered...
35+
36+
- type: textarea
37+
id: use-case
38+
attributes:
39+
label: Use Case
40+
description: Provide a code example or use case showing how this feature would be used
41+
render: tsx
42+
placeholder: |
43+
import { Streamdown } from 'streamdown';
44+
45+
// Example of how the feature would work...
46+
47+
- type: dropdown
48+
id: priority
49+
attributes:
50+
label: Priority
51+
description: How important is this feature to you?
52+
options:
53+
- Nice to have
54+
- Important
55+
- Critical
56+
57+
- type: checkboxes
58+
id: contribution
59+
attributes:
60+
label: Contribution
61+
options:
62+
- label: I am willing to help implement this feature
63+
required: false
64+
65+
- type: textarea
66+
id: additional
67+
attributes:
68+
label: Additional Context
69+
description: Add any other context, mockups, or examples about the feature request
70+
placeholder: Any additional information...

‎.github/SECURITY.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Reporting Security Issues
2+
3+
If you believe you have found a security vulnerability in the Streamdown, we encourage you to let us know right away.
4+
5+
We will investigate all legitimate reports and do our best to quickly fix the problem.
6+
7+
Email `security@vercel.com` to disclose any security vulnerabilities.
8+
9+
https://vercel.com/security

‎.github/pull_request_template.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
## Description
2+
3+
<!-- Provide a brief description of the changes in this PR -->
4+
5+
## Type of Change
6+
7+
<!-- Mark the relevant option with an "x" -->
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
- [ ] Performance improvement
14+
- [ ] Refactoring (no functional changes)
15+
16+
## Related Issues
17+
18+
<!-- Link any related issues using #issue-number -->
19+
20+
Fixes #
21+
Closes #
22+
Related to #
23+
24+
## Changes Made
25+
26+
<!-- List the specific changes made in this PR -->
27+
28+
-
29+
-
30+
-
31+
32+
## Testing
33+
34+
<!-- Describe the tests you ran to verify your changes -->
35+
36+
- [ ] All existing tests pass
37+
- [ ] Added new tests for the changes
38+
- [ ] Manually tested the changes
39+
40+
### Test Coverage
41+
42+
<!-- If applicable, include test coverage information -->
43+
44+
## Screenshots/Demos
45+
46+
<!-- If applicable, add screenshots or demos to help explain your changes -->
47+
48+
## Checklist
49+
50+
<!-- Mark completed items with an "x" -->
51+
52+
- [ ] My code follows the project's code style
53+
- [ ] I have performed a self-review of my own code
54+
- [ ] I have commented my code, particularly in hard-to-understand areas
55+
- [ ] I have made corresponding changes to the documentation
56+
- [ ] My changes generate no new warnings or errors
57+
- [ ] I have added tests that prove my fix is effective or that my feature works
58+
- [ ] New and existing unit tests pass locally with my changes
59+
- [ ] I have created a changeset (`pnpm changeset`)
60+
61+
## Changeset
62+
63+
<!-- Confirm you've created a changeset for this PR -->
64+
65+
- [ ] I have created a changeset for these changes
66+
67+
## Additional Notes
68+
69+
<!-- Add any additional notes, concerns, or discussion points -->

0 commit comments

Comments
 (0)