mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-02-03 13:11:48 +02:00
Merge pull request #34 from lucapette/add-contributing-doc
Add a CONTRIBUTING.md doc
This commit is contained in:
commit
331af0f250
54
CONTRIBUTING.md
Normal file
54
CONTRIBUTING.md
Normal file
@ -0,0 +1,54 @@
|
|||||||
|
# Contributing
|
||||||
|
|
||||||
|
By participating to this project, you agree to abide our [code of
|
||||||
|
conduct](/CODE_OF_CONDUCT.md).
|
||||||
|
|
||||||
|
## Setup your machine
|
||||||
|
|
||||||
|
`releaser` is written in [Go](https://golang.org/).
|
||||||
|
|
||||||
|
Prerequisites are:
|
||||||
|
|
||||||
|
* Build:
|
||||||
|
* `make`
|
||||||
|
* [Go 1.7+](http://golang.org/doc/install)
|
||||||
|
|
||||||
|
Clone `releaser` from source:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ git clone https://github.com/goreleaser/releaser.git
|
||||||
|
$ cd releaser
|
||||||
|
```
|
||||||
|
|
||||||
|
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
|
||||||
|
$ go build
|
||||||
|
```
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
Push your branch to your `releaser` fork and open a pull request against the
|
||||||
|
master branch.
|
Loading…
x
Reference in New Issue
Block a user