From ce59b93a3a31990a64de65ba94f2a68456badcb8 Mon Sep 17 00:00:00 2001 From: Alessandro De Angelis Date: Wed, 10 Apr 2019 14:23:49 +0200 Subject: [PATCH] contribuiting --- CONTRIBUTING.md | 14 ++++++++++++++ docs/dev.md | 27 +++++++++++++++++++++++++++ 2 files changed, 41 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 docs/dev.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..64600374 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contribuiting + +Thanks for contribuiting! + +## Setup the Environment first + +Follow the [guide](/docs/dev.md) + + +## Pull Requests + +* PR should have a proper title and a commit messagge. +* PR should includes tests. +* Open the PR against the master branch. diff --git a/docs/dev.md b/docs/dev.md new file mode 100644 index 00000000..40508c72 --- /dev/null +++ b/docs/dev.md @@ -0,0 +1,27 @@ +# Environment Setup + +## Go + +You must install [go](https://golang.org/doc/install). + +## Installing dependencies + +Dependencies are handled using [dep](https://github.com/golang/dep), [here](https://golang.github.io/dep/docs/installation.html) is the guide to install it. + +Once installed run: + +``` +dep ensure +``` + +which will install the project's dependencies + +## Linter + +This project use [golangci-lint](https://github.com/golangci/golangci-lint), [here](https://github.com/golangci/golangci-lint#install) the guide to install it. + +Once installed run: + +``` +golangci-lint run +```