-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
21 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
Contributing | ||
============ | ||
|
||
## Prerequisites | ||
To release the SDK from your local development device you need: | ||
- Node installed on your development device | ||
- Clone https://github.com/bitvavo/node-bitvavo-api to your development device | ||
- The [Bitvavo password for NPM] from the Exchange Backbone team vault in 1Password | ||
|
||
## Test and Publish the SDK | ||
After you have made your changes to the SDK, to publish Bitvavo SDK for Node.js: | ||
1. **Test the package** | ||
1. Run the smoke tests in `<repo-root>/example/testApi.js` | ||
2. **Release the SDK** | ||
1. Please check the current version and decide which new version to use. | ||
2. Run the [Release workflow] and specify the new version you want the release to have. | ||
3. After a successful run, the new package will be published to https://www.npmjs.com/package/bitvavo | ||
|
||
|
||
[Bitvavo password for NPM]: https://start.1password.com/open/i?a=YUSMSDGGJBG5JDUAGUSBP4GYWM&v=asrum7nvbb2agfh3ob532ekbfy&i=f3i334rmzgxejycgufdwiiua3u&h=bitvavo.1password.com | ||
[Release workflow]: https://github.com/bitvavo/node-bitvavo-api/actions/workflows/release.yml |