Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

55 lines (36 loc) · 2.29 KB
Raw

Contributing

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

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. When you have tested your code updates, make a pull request to the master branch.

  2. Create a test package

    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 pypi 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. The release action builds the SDK package and uploads to https://test.pypi.org/project/python-bitvavo-api/.

  3. Test the package

    1. In a clean virtual environment, create a new directory, then download the test package:

      python3 -m pip install --index-url https://test.pypi.org/simple/ python-bitvavo-api

    2. Follow the instructions in Create a simple Bitvavo implementation and make a sample app. When the functionality you implemented works, the package is good. If you cannot make a call, the debugger is your friend.

  4. Publish the SDK

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

    2. Add a brief description about the release.

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

    3. Click Publish.

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

Now send the release message in Slack, yay.