Skip to content

add a contributing guide #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 13, 2023
Merged

add a contributing guide #23

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9608e09
add a contributing guide
zeke Mar 13, 2023
b2969b7
Update CONTRIBUTING.md
zeke Mar 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing

**This is an early alpha. The implementation might change between versions
without warning. Please use at your own risk and pin to a specific version if
you're relying on this for anything important!**

## Development

Make sure you have a recent version of Node.js installed (`>=18`). Then run:

```
npm install
npm test
```

## Releases

To cut a new release, run:

```
cd replicate-js
git checkout main
git pull
npx np minor
```

This will:

- Run tests locally
- Bump the version in `package.json`
- Commit and tag the release
- Push the commit and tag to GitHub
- Publish the package to npm
- Create a GitHub release