Skip to content

Latest commit

 

History

History
55 lines (38 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

55 lines (38 loc) · 1.01 KB
Raw

Contributing Guide

Welcome to the Viam TypeScript SDK. Please read this guide prior to opening a pull request.

Development setup

Developing on the TypeScript SDK requires macOS or Linux. To get started, clone this repository:

git clone https://github.com/viamrobotics/viam-typescript-sdk.git

Prerequisites

You'll need to make sure the following tools are installed on your machine and accessible in your PATH.

  • Node.js
    • node
    • npm
  • Protobuf
    • protobuf
    • protoc-gen-grpc-web

Makefile targets

To get started, run make all to install development dependencies, run checks, build the distributable artifacts, and build docs:

# run sequentially
make all

# run in parallel
make all -j

You can also use individual targets:

# setup development dependencies
make setup

# remove development dependencies
make teardown

# build artifacts
make build

# remove artifacts
make clean

# run tests, checks, and code formatting
make test
make lint
make format