1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2024-12-27 01:33:39 +02:00
goreleaser/CONTRIBUTING.md
Jorin Vogel 1b8424b1db
Update contributing guide and fix local tests.
- fpm is required to pass tests.
- apex/log package needs to be available.
- gpgSign git option needs to be disabled for test repo.
  This is an issue when a developer has set gpgSign to true in
  their global .gitconfig file.
2017-07-10 13:50:05 +02:00

1.1 KiB

Contributing

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

Setup your machine

goreleaser is written in Go.

Prerequisites are:

Clone goreleaser from source into $GOPATH:

$ mkdir -p $GOPATH/src/github.com/github.com/goreleaser
$ cd $_
$ git clone git@github.com:goreleaser/goreleaser.git
$ cd goreleaser

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:

$ make 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 goreleaser fork and open a pull request against the master branch.