Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (42 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 1.69 KB

Contributing

Working Locally

Initial Setup

git clone git@github.com:steadybit/cli.git

Local CLI Execution

# Define environment variables
export STEADYBIT_TOKEN="..."
export STEADYBIT_URL="http://localhost:8080"

# Build the CLI locally
npm run build

# Run some CLI commands
./cli experiment get -k ADM-1

Local CLI installation

# Build the CLI locally
npm run build
# Package the CLI locally
npm pack
# Install the local package
npm i -g steadybit-1.0.0.tgz

Releasing

# Prepare the release

# Edit CHANGELOG.md by renaming the `## Unreleased` header to `## v{next release number}`
git add CHANGELOG.md
git commit -m 'chore: prepare release'

# Make the release
npm run ci
npm version {major|minor|patch}
git push --tags origin main

Contributor License Agreement (CLA)

In order to accept your pull request, we need you to submit a CLA. You only need to do this once. If you are submitting a pull request for the first time, just submit a Pull Request and our CLA Bot will give you instructions on how to sign the CLA before merging your Pull Request.

All contributors must sign an Individual Contributor License Agreement.

If contributing on behalf of your company, your company must sign a Corporate Contributor License Agreement. If so, please contact us via office@steadybit.com.

If for any reason, your first contribution is in a PR created by other contributor, please just add a comment to the PR with the following text to agree our CLA: "I have read the CLA Document and I hereby sign the CLA".