1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-24 04:16:27 +02:00
goreleaser/CONTRIBUTING.md

55 lines
973 B
Markdown
Raw Normal View History

2017-01-02 18:08:49 +01:00
# Contributing
By participating to this project, you agree to abide our [code of
conduct](/CODE_OF_CONDUCT.md).
## Setup your machine
2017-01-17 10:47:34 -02:00
`goreleaser` is written in [Go](https://golang.org/).
2017-01-02 18:08:49 +01:00
Prerequisites are:
* Build:
* `make`
2017-02-23 14:50:20 -03:00
* [Go 1.8+](http://golang.org/doc/install)
2017-01-02 18:08:49 +01:00
2017-01-17 10:47:34 -02:00
Clone `goreleaser` from source into `$GOPATH`:
2017-01-02 18:08:49 +01:00
```sh
$ go get github.com/goreleaser/goreleaser
$ cd $GOPATH/src/github.com/goreleaser/goreleaser
2017-01-02 18:08:49 +01:00
```
Install the build and lint dependencies:
``` sh
$ make setup
```
A good way of making sure everything is all right is running the test suite:
``` sh
$ make test
```
## Test your change
You can create a branch for your changes and try to build from the source as you go:
``` sh
2017-04-21 16:20:34 -03:00
$ make build
2017-01-02 18:08:49 +01:00
```
When you are satisfied with the changes, we suggest you run:
``` sh
$ make ci
```
Which runs all the linters and tests.
## Submit a pull request
2017-01-17 10:47:34 -02:00
Push your branch to your `goreleaser` fork and open a pull request against the
2017-01-02 18:08:49 +01:00
master branch.