Skip to content

Commit

Permalink
chore: add initial contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
egoist committed Mar 29, 2019
1 parent efa7659 commit c4572b9
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing to Saber

## Set up Saber locally

Fork this project, then:

```bash
git clone [email protected]:$USER/saber.git
cd saber

# Install dependencies
yarn

# Link the `saber` binary
cd packages/saber
yarn link

# If you wanna run the website locally
cd website
yarn
yarn dev # which uses the global `saber` command
```

## Publish a new version

```bash
# In root directory
# Analyze git history, create git tag and update upstream
yarn lerna version --conventional-commits
# Publish to npm
yarn lerna publish from-git
```

0 comments on commit c4572b9

Please sign in to comment.