Skip to content

Commit

Permalink
contribuiting
Browse files Browse the repository at this point in the history
  • Loading branch information
Girbons committed Apr 10, 2019
1 parent ff9163a commit ce59b93
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
27 changes: 27 additions & 0 deletions docs/dev.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit ce59b93

Please sign in to comment.