Giter VIP home page Giter VIP logo

api's Introduction

API

Protobuf definitions for Viam's public-facing API.

Contributing

Development

  • make setup - Setup your development environment
  • make all - Clean and build the Go and web generated libraries
  • make dist/buf - Build the Go and web generated libraries without cleaning
  • make clean - Clean tool cache

Submitting PRs for Protobuf Changes

  • Only submit PRs with changes to .proto files, CI will handle generating other files.
    • Upon (first) approval of the PR, file generation will happen.
    • Wait for it to complete (it will add a protos-compiled label and new files to the PR) before merging.
    • Do not make further changes after this point.
    • If stuck waiting for merge checks after protos-compiled is added, try adding an unrelated label (ex: enhancement) to trigger it again.
  • Do not make breaking changes to APIs if it can be avoided.
  • Always use semantic version tags (not hashes) when importing this into other projects, such as RDK.
    • For example, use go get go.viam.com/[email protected] NOT go get go.viam.com/api@037415e
    • Add a new (semantic version compatible) tag when needed for this.
    • Do NOT duplicate, move, or remove version tags.

License

Copyright 2023 Viam Inc.

Apache 2.0 - See LICENSE file

api's People

Contributors

agreenb avatar tahiyasalam avatar aaroncasas avatar alexis-wei avatar edaniels avatar njooma avatar roxyfarhad avatar stevebriskin avatar maximpertsov avatar mnocito avatar adammagaluk avatar michaellee1019 avatar ehhong avatar nfranczak avatar bhaney avatar otterverse avatar zaporter-work avatar cheukt avatar piokasar avatar mrloureed avatar benjirewis avatar dmhilly avatar biotinker avatar acrantel avatar jeremyrhyde avatar nicksanford avatar sbal13 avatar kschappacher avatar kaywux avatar oliviamiller avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.