Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 782 Bytes

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 782 Bytes

Contributing

Setup your machine

couchbase-exporter is written in Go, version 1.11 and beyond.

Prerequisites:

  • make
  • Go 1.11+
  • jsonnet (to generate grafana dashboards)

Clone the project anywhere:

$ git clone [email protected]:totvslabs/couchbase-exporter.git

Install the build and lint dependencies:

$ make setup

A good way of making sure everything is all right is running the test suite:

$ make test

Test your change

You can create a branch for your changes and try to build from the source as you go:

$ make build

When you are satisfied with the changes, we suggest you run:

$ make ci

Which runs all the linters and tests.