-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |