1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2024-12-31 01:53:50 +02:00
goreleaser/CONTRIBUTING.md
Carlos Alexandro Becker 94a8de5347
build: use go 1.23 (#5082)
update everything to go 1.23

Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
2024-08-18 16:08:55 -03:00

1.9 KiB

Contributing

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

Set up 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:

go mod tidy

You should then be able to build the binary:

go build -o goreleaser .
./goreleaser --version

A note about Docker multi-arch builds

If you want to properly run the Docker tests, or run goreleaser release --snapshot locally, you might need to setup Docker for it. You can do so by running:

task docker:setup

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

Before you commit the changes, we also suggest you run:

task fmt

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

You can contribute in our OpenCollective or to any of the contributors directly. See this page for more details.