1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-10-30 23:58:09 +02:00

Add a CONTRIBUTING.md doc

This commit is contained in:
lucapette
2017-01-02 18:08:49 +01:00
parent f772490cd0
commit 0f97302012
2 changed files with 58 additions and 0 deletions

54
CONTRIBUTING.md Normal file
View 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.6+](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.

View File

@@ -108,6 +108,10 @@ class Release < Formula
end
```
## How to contribute
Please refer to our [contributing guidelines](/CONTRIBUTING.md).
## Badges
Feel free to use it in your own projects: