Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

48 lines (31 loc) · 1.8 KB

Contributing

The release process for Bitvavo SDK for Node.js is semi-automatic. You manually start the GitHub Action that creates the SDK package and uploads it to npmjs.

Prerequisites

To release the SDK you need to:

Release a new version of the SDK

To update the SDK and publish your changes to the Bitvavo developer community:

  1. Make your updates to the SDK

    Create a branch and implement your changes to the SDK.

  2. Test the package

    1. Run the smoke tests in <repo-root>/example/testApi.js
    2. When your code passes the smoke tests, make a pull request to the master branch.

  3. Publish the SDK

    1. When your pull request is approved, merge your changes to the master branch.

    2. Note the release number of the latest version of the SDK published to npmjs and using semver as your guide, decide on a version number for this release.

    3. In Actions, run the release action using your new release number.

    4. Open the draft release created when you ran the release action.

    5. Add a brief description about the release.

      This description is visible to the world in https://github.com/bitvavo/node-bitvavo-api/releases.

    6. Click Publish.

      This starts the Publish action. You see the new version available on npmjs.

Now send the release message in Slack, yay.