go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-02-05 13:15:26 +02:00
Code Issues Releases Activity

docs: using conventional commits (#907)

Browse Source 
* docs: using conventional commits

* docs: format
This commit is contained in:
Carlos Alexandro Becker 2019-01-01 13:19:57 -02:00 committed by GitHub
parent dd59e0c9a2
commit e1eeba292f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@ -52,27 +52,11 @@ Which runs all the linters and tests.
## Create a commit ## Create a commit
Commit messages should be well formatted. Commit messages should be well formatted, and to make that "standarized", we
Start your commit message with the type. Choose one of the following: are using Convetional Commits.
`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. You can follow the documentation on
Keep the width of the text at 72 chars. [their website](https://www.conventionalcommits.org).
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 ## Submit a pull request

12
README.md
View File

@ -20,7 +20,17 @@ Documentation is hosted live at https://goreleaser.com
## Badges ## Badges
[![Release](https://img.shields.io/github/release/goreleaser/goreleaser.svg?style=for-the-badge)](https://github.com/goreleaser/goreleaser/releases/latest) [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge)](/LICENSE.md) [![Travis](https://img.shields.io/travis/goreleaser/goreleaser/master.svg?style=for-the-badge)](https://travis-ci.org/goreleaser/goreleaser) [![Codecov branch](https://img.shields.io/codecov/c/github/goreleaser/goreleaser/master.svg?style=for-the-badge)](https://codecov.io/gh/goreleaser/goreleaser) [![Go Report Card](https://goreportcard.com/badge/github.com/goreleaser/goreleaser?style=for-the-badge)](https://goreportcard.com/report/github.com/goreleaser/goreleaser) [![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=for-the-badge)](http://godoc.org/github.com/goreleaser/goreleaser) [![SayThanks.io](https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg?style=for-the-badge)](https://saythanks.io/to/caarlos0) [![Powered By: GoReleaser](https://img.shields.io/badge/powered%20by-goreleaser-green.svg?style=for-the-badge)](https://github.com/goreleaser) [![Backers on Open Collective](https://opencollective.com/auditnet/backers/badge.svg?style=for-the-badge)](https://opencollective.com/auditnet/backers/) [![Sponsors on Open Collective](https://opencollective.com/auditnet/sponsors/badge.svg?style=for-the-badge)](https://opencollective.com/auditnet/sponsors/) [![Release](https://img.shields.io/github/release/goreleaser/goreleaser.svg?style=for-the-badge)](https://github.com/goreleaser/goreleaser/releases/latest)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=for-the-badge)](/LICENSE.md)
[![Travis](https://img.shields.io/travis/goreleaser/goreleaser/master.svg?style=for-the-badge)](https://travis-ci.org/goreleaser/goreleaser)
[![Codecov branch](https://img.shields.io/codecov/c/github/goreleaser/goreleaser/master.svg?style=for-the-badge)](https://codecov.io/gh/goreleaser/goreleaser)
<!-- [![Go Report Card](https://goreportcard.com/badge/github.com/goreleaser/goreleaser?style=for-the-badge)](https://goreportcard.com/report/github.com/goreleaser/goreleaser) -->
[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=for-the-badge)](http://godoc.org/github.com/goreleaser/goreleaser)
[![SayThanks.io](https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg?style=for-the-badge)](https://saythanks.io/to/caarlos0)
[![Powered By: GoReleaser](https://img.shields.io/badge/powered%20by-goreleaser-green.svg?style=for-the-badge)](https://github.com/goreleaser)
[![Backers on Open Collective](https://opencollective.com/auditnet/backers/badge.svg?style=for-the-badge)](https://opencollective.com/auditnet/backers/)
[![Sponsors on Open Collective](https://opencollective.com/auditnet/sponsors/badge.svg?style=for-the-badge)](https://opencollective.com/auditnet/sponsors/)
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge)](https://conventionalcommits.org)
## Sponsors ## Sponsors