Skip to content

Commit 6fa9006

Browse files
zekeerbridge
andauthored
add a contributing guide (#23)
* add a contributing guide * Update CONTRIBUTING.md Co-authored-by: F <f@replicate.com> --------- Co-authored-by: F <f@replicate.com>
1 parent ea06f3f commit 6fa9006

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing
2+
3+
**This is an early alpha. The implementation might change between versions
4+
without warning. Please use at your own risk and pin to a specific version if
5+
you're relying on this for anything important!**
6+
7+
## Development
8+
9+
Make sure you have a recent version of Node.js installed (`>=18`). Then run:
10+
11+
```
12+
npm install
13+
npm test
14+
```
15+
16+
## Releases
17+
18+
To cut a new release, run:
19+
20+
```
21+
cd replicate-js
22+
git checkout main
23+
git pull
24+
npx np minor
25+
```
26+
27+
This will:
28+
29+
- Run tests locally
30+
- Bump the version in `package.json`
31+
- Commit and tag the release
32+
- Push the commit and tag to GitHub
33+
- Publish the package to npm
34+
- Create a GitHub release

0 commit comments

Comments
 (0)