Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 1.39 KB
Raw

Contributing

By participating to this project, you agree to abide our code of conduct.

Setup your machine

message-cannon is written in Go.

Prerequisites are:

Clone message-cannon from source into $GOPATH:

$ git clone [email protected]:leandro-lugaresi/message-cannon.git $GOPATH/src/github.com/leandro-lugaresi/message-cannon
$ cd $GOPATH/src/github.com/leandro-lugaresi/message-cannon

If you created a fork clone your fork and after add the my repository as upstream remote:

$ git clone [email protected]:{your-name}/message-cannon.git $GOPATH/src/github.com/leandro-lugaresi/message-cannon
$ cd $GOPATH/src/github.com/leandro-lugaresi/message-cannon
$ git remote add upstream [email protected]:leandro-lugaresi/message-cannon.git

Install

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:

$ go build

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

$ make ci

Which runs all the linters and tests.

Submit a pull request

Push your branch to your example fork and open a pull request against the master branch.