2017-01-02 19:08:49 +02:00
# Contributing
2021-11-12 22:23:32 +02:00
By participating to this project, you agree to abide our [code of conduct ](https://github.com/goreleaser/goreleaser/blob/main/CODE_OF_CONDUCT.md ).
2017-01-02 19:08:49 +02:00
## Setup your machine
2017-01-17 14:47:34 +02:00
`goreleaser` is written in [Go ](https://golang.org/ ).
2017-01-02 19:08:49 +02:00
2017-10-02 12:35:20 +02:00
Prerequisites:
2021-10-06 01:05:22 +02:00
- [Task ](https://taskfile.dev/#/installation )
2021-08-25 01:49:11 +02:00
- [Go 1.17+ ](https://golang.org/doc/install )
2021-10-10 16:09:08 +02:00
Other things you might need to run the tests:
- [Buildpacks ](https://buildpacks.io/ )
- [cosign ](https://github.com/sigstore/cosign )
2018-05-28 15:49:38 +02:00
- [Docker ](https://www.docker.com/ )
2021-10-10 16:09:08 +02:00
- [GPG ](https://gnupg.org )
- [Podman ](https://podman.io/ )
- [Snapcraft ](https://snapcraft.io/ )
2017-01-02 19:08:49 +02:00
2018-10-31 04:23:47 +02:00
Clone `goreleaser` anywhere:
2017-01-02 19:08:49 +02:00
```sh
2020-08-14 23:13:02 +02:00
git clone git@github.com:goreleaser/goreleaser.git
2017-01-02 19:08:49 +02:00
```
2021-03-01 19:45:06 +02:00
`cd` into the directory and install the dependencies:
2017-01-02 19:08:49 +02:00
2019-03-25 01:10:30 +02:00
```sh
2021-10-06 01:05:22 +02:00
task setup
2017-01-02 19:08:49 +02:00
```
A good way of making sure everything is all right is running the test suite:
2019-03-25 01:10:30 +02:00
```sh
2021-10-06 01:05:22 +02:00
task test
2017-01-02 19:08:49 +02:00
```
## Test your change
You can create a branch for your changes and try to build from the source as you go:
2019-03-25 01:10:30 +02:00
```sh
2021-10-06 01:05:22 +02:00
task build
2017-01-02 19:08:49 +02:00
```
When you are satisfied with the changes, we suggest you run:
2019-03-25 01:10:30 +02:00
```sh
2021-10-06 01:05:22 +02:00
task ci
2017-01-02 19:08:49 +02:00
```
2017-10-01 20:15:06 +02:00
## Create a commit
2019-06-06 06:35:50 +02:00
Commit messages should be well formatted, and to make that "standardized", we
are using Conventional Commits.
2017-10-01 20:15:06 +02:00
2019-01-01 17:19:57 +02:00
You can follow the documentation on
[their website ](https://www.conventionalcommits.org ).
2017-10-01 20:15:06 +02:00
2017-01-02 19:08:49 +02:00
## Submit a pull request
2021-11-12 22:23:32 +02:00
Push your branch to your `goreleaser` fork and open a pull request against the main branch.
2018-01-24 00:59:29 +02:00
## Financial contributions
We also welcome financial contributions in full transparency on our [open collective ](https://opencollective.com/goreleaser ).
Anyone can file an expense. If the expense makes sense for the development of the community, it will be "merged" in the ledger of our open collective by the core contributors and the person who filed the expense will be reimbursed.
