From 9608e09aa4d287c5f20b359d41ac7dcb4acaf652 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Mon, 13 Mar 2023 11:36:49 -0700 Subject: [PATCH 1/2] add a contributing guide --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..9f988bf3 --- /dev/null +++ b/CONTRIBUTING.md @@ -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 From b2969b75ebd55c255b06914ef1c3f26dcb4467cc Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Mon, 13 Mar 2023 14:09:04 -0700 Subject: [PATCH 2/2] Update CONTRIBUTING.md Co-authored-by: F --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f988bf3..ab1d859d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -## Contributing +# 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