From e96f2fca11b2014119331d83f058482af248c1ec Mon Sep 17 00:00:00 2001
From: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
Date: Fri, 21 Dec 2018 13:45:56 -0200
Subject: [PATCH] docs: CONTRIBUTING.mnd

---
 CONTRIBUTING.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..9eac8ae
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,45 @@
+# Contributing
+
+## Setup your machine
+
+`couchbase-exporter` is written in [Go](https://golang.org/), version 1.11 and beyond.
+
+Prerequisites:
+
+- `make`
+- [Go 1.11+](https://golang.org/doc/install)
+- `jsonnet` (to generate grafana dashboards)
+
+Clone the project anywhere:
+
+```sh
+$ git clone git@github.com:totvslabs/couchbase-exporter.git
+```
+
+Install the build and lint dependencies:
+
+```console
+$ make setup
+```
+
+A good way of making sure everything is all right is running the test suite:
+
+```console
+$ make test
+```
+
+## Test your change
+
+You can create a branch for your changes and try to build from the source as you go:
+
+```console
+$ make build
+```
+
+When you are satisfied with the changes, we suggest you run:
+
+```console
+$ make ci
+```
+
+Which runs all the linters and tests.