How to contribute

Releasing

Just like with the js-stellar-base library, there are a few important things to remember when releasing a new version of the library.

In fact, you should follow the steps there, first, except for this repository. Then:

Upgrade all of the dependencies that you can, so that we don't fall too far behind. You can do this by running yarn upgrade-interactive --latest. You can avoid breaking changes if there is a migration necessary, but remember to handle these quickly in a subsequent release.

Finally, if base has been updated, you want to follow the additional steps here:

First, bump its version accordingly. This is straightforward: change the version field of "stellar-base" under the "dependencies" section in the SDK's package.json, e.g.:

  "dependencies": {
     ...
-    "stellar-base": "^1.0.0",
+    "stellar-base": "^2.0.0",
  }

Then, run yarn so that the dependency is pulled (ensuring its a valid version) and the lockfile is updated with the latest integrity details.

You can now commit the change and PR accordingly.