github.com/joselitofilho/goreleaser@v0.155.1-0.20210123221854-e4891856c593/CONTRIBUTING.md (about)

     1  # Contributing
     2  
     3  By participating to this project, you agree to abide our [code of
     4  conduct](/CODE_OF_CONDUCT.md).
     5  
     6  ## Setup your machine
     7  
     8  `goreleaser` is written in [Go](https://golang.org/).
     9  
    10  Prerequisites:
    11  
    12  - `make`
    13  - [Go 1.15+](https://golang.org/doc/install)
    14  - [snapcraft](https://snapcraft.io/)
    15  - [Docker](https://www.docker.com/)
    16  - `gpg` (probably already installed on your system)
    17  
    18  Clone `goreleaser` anywhere:
    19  
    20  ```sh
    21  git clone git@github.com:goreleaser/goreleaser.git
    22  ```
    23  
    24  Install the build and lint dependencies:
    25  
    26  ```sh
    27  make setup
    28  ```
    29  
    30  A good way of making sure everything is all right is running the test suite:
    31  
    32  ```sh
    33  make test
    34  ```
    35  
    36  ## Test your change
    37  
    38  You can create a branch for your changes and try to build from the source as you go:
    39  
    40  ```sh
    41  make build
    42  ```
    43  
    44  When you are satisfied with the changes, we suggest you run:
    45  
    46  ```sh
    47  make ci
    48  ```
    49  
    50  Which runs all the linters and tests.
    51  
    52  ## Create a commit
    53  
    54  Commit messages should be well formatted, and to make that "standardized", we
    55  are using Conventional Commits.
    56  
    57  You can follow the documentation on
    58  [their website](https://www.conventionalcommits.org).
    59  
    60  ## Submit a pull request
    61  
    62  Push your branch to your `goreleaser` fork and open a pull request against the
    63  master branch.
    64  
    65  ## Financial contributions
    66  
    67  We also welcome financial contributions in full transparency on our [open collective](https://opencollective.com/goreleaser).
    68  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.
    69  
    70  ## Credits
    71  
    72  ### Contributors
    73  
    74  Thank you to all the people who have already contributed to GoReleaser!
    75  <a href="graphs/contributors"><img src="https://opencollective.com/goreleaser/contributors.svg?width=890" /></a>
    76  
    77  ### Backers
    78  
    79  Thank you to all our backers! [[Become a backer](https://opencollective.com/goreleaser#backer)]
    80  
    81  <a href="https://opencollective.com/goreleaser#backers" target="_blank"><img src="https://opencollective.com/goreleaser/backers.svg?width=890"></a>
    82  
    83  ### Sponsors
    84  
    85  Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/goreleaser#sponsor))
    86  
    87  <a href="https://opencollective.com/goreleaser/sponsor/0/website" target="_blank"><img src="https://opencollective.com/goreleaser/sponsor/0/avatar.svg"></a>
    88  <a href="https://opencollective.com/goreleaser/sponsor/1/website" target="_blank"><img src="https://opencollective.com/goreleaser/sponsor/1/avatar.svg"></a>
    89  <a href="https://opencollective.com/goreleaser/sponsor/2/website" target="_blank"><img src="https://opencollective.com/goreleaser/sponsor/2/avatar.svg"></a>
    90  <a href="https://opencollective.com/goreleaser/sponsor/3/website" target="_blank"><img src="https://opencollective.com/goreleaser/sponsor/3/avatar.svg"></a>
    91  <a href="https://opencollective.com/goreleaser/sponsor/4/website" target="_blank"><img src="https://opencollective.com/goreleaser/sponsor/4/avatar.svg"></a>
    92  <a href="https://opencollective.com/goreleaser/sponsor/5/website" target="_blank"><img src="https://opencollective.com/goreleaser/sponsor/5/avatar.svg"></a>
    93  <a href="https://opencollective.com/goreleaser/sponsor/6/website" target="_blank"><img src="https://opencollective.com/goreleaser/sponsor/6/avatar.svg"></a>
    94  <a href="https://opencollective.com/goreleaser/sponsor/7/website" target="_blank"><img src="https://opencollective.com/goreleaser/sponsor/7/avatar.svg"></a>
    95  <a href="https://opencollective.com/goreleaser/sponsor/8/website" target="_blank"><img src="https://opencollective.com/goreleaser/sponsor/8/avatar.svg"></a>
    96  <a href="https://opencollective.com/goreleaser/sponsor/9/website" target="_blank"><img src="https://opencollective.com/goreleaser/sponsor/9/avatar.svg"></a>