mirror of
https://github.com/goreleaser/nfpm
synced 2024-09-23 06:41:18 +02:00
19817233b5
* feat: remove deprecated options Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * test: fixing Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * fix: configs Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * fix: tempdir Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * fix: fmt Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * feat: go 1.15 Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * test: fix Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * test: fix Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * test: fix Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * fix: tests Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * refactor: test Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * fix: lint Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * fix: import Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * fix: test Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com> * fix: symlink Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com>
89 lines
2.3 KiB
Markdown
89 lines
2.3 KiB
Markdown
# Contributing
|
|
|
|
By participating to this project, you agree to abide our [code of
|
|
conduct](/CODE_OF_CONDUCT.md).
|
|
|
|
## Setup your machine
|
|
|
|
`nfpm` is written in [Go](https://golang.org/).
|
|
|
|
Prerequisites:
|
|
|
|
* `make`
|
|
* [Go 1.15+](https://golang.org/doc/install)
|
|
|
|
Clone `nfpm` from source:
|
|
|
|
```sh
|
|
$ git clone git@github.com:goreleaser/nfpm.git
|
|
$ cd nfpm
|
|
```
|
|
|
|
Install the build and lint dependencies:
|
|
|
|
```console
|
|
$ make setup
|
|
```
|
|
|
|
A good way of making sure everything is all right is running the test suite:
|
|
|
|
```console
|
|
$ make test
|
|
```
|
|
|
|
If on the ARM tests you are seeing `standard_init_linux.go:211: exec user process caused "exec format error"`:
|
|
|
|
```console
|
|
$ sudo docker run --rm --privileged hypriot/qemu-register
|
|
```
|
|
|
|
## Test your change
|
|
|
|
You can create a branch for your changes and try to build from the source as you go:
|
|
|
|
```console
|
|
$ make build
|
|
```
|
|
|
|
When you are satisfied with the changes, we suggest you run:
|
|
|
|
```console
|
|
$ make ci
|
|
```
|
|
|
|
Which runs all the linters and tests.
|
|
|
|
## Create a commit
|
|
|
|
Commit messages should be well formatted.
|
|
Start your commit message with the type. Choose one of the following:
|
|
`feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `chore`, `revert`, `add`, `remove`, `move`, `bump`, `update`, `release`
|
|
|
|
After a colon, you should give the message a title, starting with uppercase and ending without a dot.
|
|
Keep the width of the text at 72 chars.
|
|
The title must be followed with a newline, then a more detailed description.
|
|
|
|
Please reference any GitHub issues on the last line of the commit message (e.g. `See #123`, `Closes #123`, `Fixes #123`).
|
|
|
|
An example:
|
|
|
|
```
|
|
docs: Add example for --release-notes flag
|
|
|
|
I added an example to the docs of the `--release-notes` flag to make
|
|
the usage more clear. The example is an realistic use case and might
|
|
help others to generate their own changelog.
|
|
|
|
See #284
|
|
```
|
|
|
|
## Submit a pull request
|
|
|
|
Push your branch to your `nfpm` 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.
|