mirror of
https://github.com/goreleaser/nfpm
synced 2024-04-20 13:24:01 +02:00
docs: readme, coc, contributing
This commit is contained in:
Carlos Alexandro Becker
parent
8bb63d15b7
commit
14cecc0b8b
|
|
@ -0,0 +1,74 @@
|
|||
# Contributor Covenant Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, gender identity and expression, level of experience,
|
||||
nationality, personal appearance, race, religion, or sexual identity and
|
||||
orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Using welcoming and inclusive language
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
* Showing empathy towards other community members
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexualized language or imagery and unwelcome sexual attention or
|
||||
advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
* Other conduct which could reasonably be considered inappropriate in a
|
||||
professional setting
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at root@carlosbecker.com. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at [http://contributor-covenant.org/version/1/4][version]
|
||||
|
||||
[homepage]: http://contributor-covenant.org
|
||||
[version]: http://contributor-covenant.org/version/1/4/
|
||||
|
|
@ -0,0 +1,85 @@
|
|||
# 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.10+](https://golang.org/doc/install)
|
||||
* rpm (`apt-get intall rpm`/`brew install rpm`)
|
||||
|
||||
Clone `nfpm` from source into `$GOPATH`:
|
||||
|
||||
```sh
|
||||
$ mkdir -p $GOPATH/src/github.com/goreleaser/nfpm
|
||||
$ cd $_
|
||||
$ 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
|
||||
```
|
||||
|
||||
## 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.
|
||||
40
README.md
40
README.md
|
|
@ -1,8 +1,23 @@
|
|||
# nfpm
|
||||
<p align="center">
|
||||
<img alt="GoReleaser Logo" src="https://avatars2.githubusercontent.com/u/24697112?v=3&s=200" height="140" />
|
||||
<h3 align="center">NFPM</h3>
|
||||
<p align="center">NFPM is Not FPM - a simple deb and rpm packager written in Go.</p>
|
||||
<p align="center">
|
||||
<a href="https://github.com/goreleaser/nfpm/releases/latest"><img alt="Release" src="https://img.shields.io/github/release/goreleaser/nfpm.svg?style=flat-square"></a>
|
||||
<a href="/LICENSE.md"><img alt="Software License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square"></a>
|
||||
<a href="https://travis-ci.org/goreleaser/nfpm"><img alt="Travis" src="https://img.shields.io/travis/goreleaser/nfpm/master.svg?style=flat-square"></a>
|
||||
<a href="https://codecov.io/gh/goreleaser/nfpm"><img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/goreleaser/nfpm/master.svg?style=flat-square"></a>
|
||||
<a href="https://goreportcard.com/report/github.com/goreleaser/nfpm"><img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/goreleaser/nfpm?style=flat-square"></a>
|
||||
<a href="http://godoc.org/github.com/goreleaser/nfpm"><img alt="Go Doc" src="https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square"></a>
|
||||
<a href="https://saythanks.io/to/caarlos0"><img alt="SayThanks.io" src="https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg?style=flat-square"></a>
|
||||
<a href="https://github.com/goreleaser"><img alt="Powered By: GoReleaser" src="https://img.shields.io/badge/powered%20by-goreleaser-green.svg?style=flat-square"></a>
|
||||
<a href="https://opencollective.com/auditnet/backers/"><img alt="Backers on Open Collective" src="https://opencollective.com/auditnet/backers/badge.svg?style=flat-square"></a>
|
||||
<a href="https://opencollective.com/auditnet/sponsors/"><img alt="Sponsors on Open Collective" src="https://opencollective.com/auditnet/sponsors/badge.svg?style=flat-square"></a>
|
||||
</p>
|
||||
</p>
|
||||
|
||||
> NFPM is Not FPM - a simple deb and rpm packager written in Go
|
||||
|
||||
### Goals
|
||||
## Goals
|
||||
|
||||
* be simple to use
|
||||
* provide packaging for the most common linux packaging systems (at very least deb and rpm)
|
||||
|
|
@ -12,7 +27,7 @@
|
|||
* generate packages based on yaml files (maybe also json and toml?)
|
||||
* be possible to use it as a lib in other go projects (namely goreleaser itself)
|
||||
|
||||
### Usage
|
||||
## Usage
|
||||
|
||||
The first steps are to run `nfpm init` to initialize a config file and edit
|
||||
the generated file according to your needs:
|
||||
|
|
@ -26,7 +41,22 @@ NFPM will guess which packager to use based on the target file extension.
|
|||
|
||||
And that's it!
|
||||
|
||||
### Status
|
||||
## Status
|
||||
|
||||
* both deb and rpm packaging are working but there are some missing features;
|
||||
* we need a suite of acceptance tests to make sure everything works.
|
||||
|
||||
|
||||
## Donate
|
||||
|
||||
Donations are very much appreciated! You can donate/sponsor on the main
|
||||
[goreleaser opencollective](https://opencollective.com/goreleaser)! It's
|
||||
easy and will surely help the developers at least buy some :coffee: or :beer:!
|
||||
|
||||
## Stargazers over time
|
||||
|
||||
[](https://starcharts.herokuapp.com/goreleaser/nfpm)
|
||||
|
||||
---
|
||||
|
||||
Would you like to fix something in the documentation? Feel free to open an [issue](https://github.com/goreleaser/nfpm/issues).
|
||||
|
|
|
|||
Loading…
Reference in New Issue