You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit c681d2b
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ Thank you for your interest in contributing to Clack! This document provides det
10
10
### Prerequisites
11
11
12
12
-[Node.js](https://nodejs.org/) (version specified in `.nvmrc`, currently v20.18.1)
13
-
-[pnpm](https://pnpm.io/) (version 9.14.2 or higher)
13
+
-[pnpm](https://pnpm.io/) (version 10.33.0 or higher)
14
14
15
15
If you use [volta](https://volta.sh/) or [nvm](https://github.com/nvm-sh/nvm), the correct Node.js version will be automatically selected based on the project's `.nvmrc` file.
16
16
@@ -63,16 +63,16 @@ If you want to test changes to Clack packages in your own project, you can use p
63
63
```bash
64
64
# In your project
65
65
cd /path/to/your-project
66
-
66
+
67
67
# Link @clack/core
68
68
pnpm link --global /path/to/clack/packages/core
69
-
69
+
70
70
# Link @clack/prompts
71
71
pnpm link --global /path/to/clack/packages/prompts
72
72
```
73
73
74
74
**Method 2: Using local path in package.json**
75
-
75
+
76
76
In your project's package.json, reference the local paths:
77
77
```json
78
78
{
@@ -97,7 +97,7 @@ If you want to test changes to Clack packages in your own project, you can use p
97
97
# In the clack repository
98
98
cd /path/to/clack
99
99
pnpm build
100
-
100
+
101
101
# In your project (if using Method 2)
102
102
cd /path/to/your-project
103
103
pnpm install
@@ -125,11 +125,11 @@ clack/
125
125
126
126
### Key Packages
127
127
128
-
1.**@clack/core** (`packages/core/`):
128
+
1.**@clack/core** (`packages/core/`):
129
129
- Contains the unstyled, extensible primitives for building CLI applications
130
130
- The foundation layer that provides the core functionality
@@ -142,7 +142,7 @@ The `examples/` directory contains sample projects that demonstrate how to use C
142
142
143
143
### Common Commands
144
144
145
-
-**Build all packages**:
145
+
-**Build all packages**:
146
146
```bash
147
147
pnpm build
148
148
```
@@ -194,14 +194,14 @@ The `examples/` directory contains sample projects that demonstrate how to use C
194
194
```bash
195
195
# Ensure everything builds
196
196
pnpm build
197
-
197
+
198
198
# Check formatting and lint issues
199
199
pnpm format
200
200
pnpm lint
201
-
201
+
202
202
# Verify type correctness
203
203
pnpm types
204
-
204
+
205
205
# Run tests
206
206
pnpm test
207
207
```
@@ -269,7 +269,7 @@ When encountering issues during development:
269
269
270
270
### PR Previews
271
271
272
-
Clack uses [pkg.pr.new](https://pkg.pr.new) (provided by [bolt.new](https://bolt.new)) to create continuous preview releases of all PRs. This simplifies testing and makes verifying bug fixes easier for our dependents.
272
+
Clack uses [pkg.pr.new](https://pkg.pr.new) (provided by [bolt.new](https://bolt.new)) to create continuous preview releases of all PRs. This simplifies testing and makes verifying bug fixes easier for our dependents.
273
273
274
274
The workflow that builds a preview version and adds instructions for installation as a comment on your PR should run automatically if you have contributed to Clack before. First-time contributors may need to wait until a maintainer manually approves GitHub Actions running on your PR.
275
275
@@ -295,10 +295,10 @@ Clack maintains a stable `v0` branch alongside the main development branch. For
0 commit comments