Home

Repository setup

Once you clone this repository, also add an upstream remote:

$ git remote add upstream git@github.com:unit-finance/unit-node-sdk.git

Ongoing

Note: Here origin is highbeamco/unit-node-sdk and upstream is unit-finance/unit-node-sdk based on setup above.

Since we want to keep our git history in sync with upstream as well as publish Highbeam's version of the changes to npm, here's the workflow right now:

• We maintain two branches: main and release
• For review we make a pull request to origin/main and once approved, one to upstream/main as well
• Once merged to origin/main, we rebase release on top of origin/main (git rebase origin/main) and drop any existing version bump commits (git rebase --skip). We then bump the version (should be higher than any prior highbeam's published versions), and npm publish
• To fetch upstream changes from time to time, we rebase origin/main on upstream/main using git pull upstream main --rebase and git rebase --skip any commits that made it into upstream/main

We will be rewriting histories of main and release this way but seems simplest for now. Open to suggestions.

Publishing

Docs here.