1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-09-16 09:26:52 +02:00

docs: contributing in sync

closes #2565

Co-authored-by: Nate <37554478+servusdei2018@users.noreply.github.com>
Signed-off-by: Carlos A Becker <caarlos0@gmail.com>
This commit is contained in:
Carlos A Becker
2021-10-10 11:16:03 -03:00
parent 398c9e6b3c
commit bf95432c53
2 changed files with 79 additions and 7 deletions

View File

@@ -62,6 +62,15 @@ tasks:
cmds:
- task: ci
docs:generate:
desc: Generate docs
cmds:
- cp -rf CONTRIBUTING.md www/docs/contributing.md
sources:
- CONTRIBUTING.md
generates:
- www/docs/contributing.md
docs:imgs:
desc: Download and resize images
cmds:
@@ -74,6 +83,7 @@ tasks:
docs:serve:
desc: Start documentation server
cmds:
- task: docs:generate
- '{{.DOCKER}} run --rm -it -p 8000:8000 -v ${PWD}/www:/docs docker.io/squidfunk/mkdocs-material'
docs:vercel:build:

View File

@@ -1,9 +1,71 @@
---
title: Contributing
---
# Contributing
This page will eventually have information for those who want to contribute
to the project.
By participating to this project, you agree to abide our [code of conduct](/CODE_OF_CONDUCT.md).
Also check the [CONTRIBUTING.md](https://github.com/goreleaser/goreleaser/blob/master/CONTRIBUTING.md)
file on the root of our repository.
## Setup your machine
`goreleaser` is written in [Go](https://golang.org/).
Prerequisites:
- [Task](https://taskfile.dev/#/installation)
- [Go 1.17+](https://golang.org/doc/install)
Other things you might need to run the tests:
- [Buildpacks](https://buildpacks.io/)
- [cosign](https://github.com/sigstore/cosign)
- [Docker](https://www.docker.com/)
- [GPG](https://gnupg.org)
- [Podman](https://podman.io/)
- [Snapcraft](https://snapcraft.io/)
Clone `goreleaser` anywhere:
```sh
git clone git@github.com:goreleaser/goreleaser.git
```
`cd` into the directory and install the dependencies:
```sh
task setup
```
A good way of making sure everything is all right is running the test suite:
```sh
task test
```
## Test your change
You can create a branch for your changes and try to build from the source as you go:
```sh
task build
```
When you are satisfied with the changes, we suggest you run:
```sh
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](https://www.conventionalcommits.org).
## Submit a pull request
Push your branch to your `goreleaser` fork and open a pull request against the
master branch.
## 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.