1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2024-12-29 01:44:39 +02:00
goreleaser/CONTRIBUTING.md
2021-11-12 17:23:32 -03:00

1.8 KiB

Contributing

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

Setup your machine

goreleaser is written in Go.

Prerequisites:

Other things you might need to run the tests:

Clone goreleaser anywhere:

git clone git@github.com:goreleaser/goreleaser.git

cd into the directory and install the dependencies:

task setup

A good way of making sure everything is all right is running the test suite:

task test

Test your change

You can create a branch for your changes and try to build from the source as you go:

task build

When you are satisfied with the changes, we suggest you run:

task ci

Create a commit

Commit messages should be well formatted, and to make that "standardized", we are using Conventional Commits.

You can follow the documentation on their website.

Submit a pull request

Push your branch to your goreleaser fork and open a pull request against the main branch.

Financial contributions

We also welcome financial contributions in full transparency on our open collective. 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.