-
-
Notifications
You must be signed in to change notification settings - Fork 112
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add initial contributing guide
- Loading branch information
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |