Skip to content

Commit 1c07a91

Browse files
committed
Update CONTRIBUTING.md
1 parent 66d405c commit 1c07a91

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Thank you for your interest in contributing to Streamdown! We welcome contributi
3131
### Project Structure
3232

3333
This is a monorepo managed with Turbo. The main package is located at:
34+
3435
- `packages/streamdown/` - The core Streamdown React component library
3536

3637
### Available Scripts
@@ -40,13 +41,14 @@ This is a monorepo managed with Turbo. The main package is located at:
4041
- `pnpm test` - Run tests
4142
- `pnpm test:coverage` - Run tests with coverage
4243
- `pnpm test:ui` - Run tests with UI
43-
- `pnpm lint` - Run linting
44-
- `pnpm format` - Format code with Prettier
44+
- `pnpm check` - Check linting and formatting
45+
- `pnpm fix` - Fix linting and formatting
4546
- `pnpm check-types` - Type checking
4647

4748
### Making Changes
4849

4950
1. Create a new branch for your feature or fix:
51+
5052
```bash
5153
git checkout -b feature/your-feature-name
5254
```
@@ -63,6 +65,7 @@ This is a monorepo managed with Turbo. The main package is located at:
6365
```bash
6466
pnpm changeset
6567
```
68+
6669
- Select the package(s) affected
6770
- Choose the appropriate version bump (patch/minor/major)
6871
- Write a concise description of the changes
@@ -80,6 +83,7 @@ We follow conventional commits for clear commit history:
8083
- `chore:` Maintenance tasks
8184

8285
Examples:
86+
8387
```
8488
feat: add support for custom code block themes
8589
fix: resolve markdown parsing issue with nested lists
@@ -153,4 +157,4 @@ Releases are automated through GitHub Actions and changesets:
153157

154158
## License
155159

156-
By contributing to Streamdown, you agree that your contributions will be licensed under the Apache-2.0 License.
160+
By contributing to Streamdown, you agree that your contributions will be licensed under the Apache-2.0 License.

0 commit comments

Comments
 (0)