Skip to content

Commit ee5649e

Browse files
committed
contributing
1 parent 68372c5 commit ee5649e

File tree

1 file changed

+9
-20
lines changed

1 file changed

+9
-20
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,48 +4,37 @@
44

55
```sh
66
npm i
7-
cd example
8-
npm i
9-
npx convex dev
7+
npm run dev
108
```
119

1210
## Testing
1311

1412
```sh
15-
rm -rf dist/ && npm run build
13+
npm run clean
14+
npm run build
1615
npm run typecheck
17-
npm run test
18-
cd example
1916
npm run lint
20-
cd ..
17+
npm run test
2118
```
2219

2320
## Deploying
2421

2522
### Building a one-off package
2623

2724
```sh
28-
rm -rf dist/ && npm run build
25+
npm run clean
26+
npm ci
2927
npm pack
3028
```
3129

3230
### Deploying a new version
3331

3432
```sh
35-
# this will change the version and commit it (if you run it in the root directory)
36-
npm version patch
37-
npm publish --dry-run
38-
# sanity check files being included
39-
npm publish
40-
git push --tags
33+
npm run release
4134
```
4235

43-
#### Alpha release
44-
45-
The same as above, but it requires extra flags so the release is only installed
46-
with `@alpha`:
36+
or for alpha release:
4737

4838
```sh
49-
npm version prerelease --preid alpha
50-
npm publish --tag alpha
39+
npm run alpha
5140
```

0 commit comments

Comments
 (0)