Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 1.21 KB

Contributing to Saber

Set up Saber locally

Fork this project, then:

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

# Install dependencies
yarn

# Link the `saber` binary if you want to run it globally
cd packages/saber
yarn link

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

Visual Studio Code users can take advantage of the debug configuration shipping with Saber, which allows testing Saber with the documentation website. If you want to debug with a different project, set cwd under .vscode/launch.json to your Saber project's working directory.

Pull Requests

Before starting to work on an issue, first ensure there are no open PRs for it already, then comment that you intend to work on it, to prevent others from wasting their time doing the same work.

If the issue you're working on is funded by IssueHunt, you also need to submit the PR URL to IssueHunt after submitting your PR on GitHub.

Publish a new version

If you have write access to this project:

# 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