toucan-sdk/GIT-WORKFLOW.md

A JavaScript SDK for Toucan Protocol. Works in the web browser and Node.js.

# git contribution workflow

We develop using [triangular workflows](https://github.blog/2015-07-29-git-2-5-including-multiple-worktrees-and-triangular-workflows/#improved-support-for-triangular-workflows) on git.

For local deployment please create a fork of the [Toucan SDK repo](https://github.com/ToucanProtocol/toucan-sdk).

Clone your fork:

```bash
git clone git@github.com:YOURUSERNAME/toucan-sdk.git
git config remote.pushdefault origin
git config push.default current
```

next add the root repository as `upstream`:

```bash
git remote add upstream git@github.com:ToucanProtocol/toucan-sdk.git
git fetch upstream
```

Run:

```bash
git remote -v
```

and you should see something like:

```bash
origin	git@github.com:YOURUSERNAME/toucan-sdk.git (fetch)
origin	git@github.com:YOURUSERNAME/toucan-sdk.git (push)
upstream	git@github.com:ToucanProtocol/toucan-sdk.git (fetch)
upstream	git@github.com:ToucanProtocol/toucan-sdk.git (push)
```

Feature flow:

```bash
git checkout main && git pull --ff-only upstream main
```

Cmd+shift+. to copy your issue number from linear, and use it as your branch name:

```bash
git checkout -b co2-190-small-edits-on-the-home-page
```

To open a PR push to your fork and open your PR to `ToucanProtocol/toucan-sdk`.