38 lines
1.7 KiB
Cheetah
38 lines
1.7 KiB
Cheetah
# {{ .Name }}
|
|
|
|
[![Release](https://img.shields.io/github/release/avast/retry-go.svg?style=flat-square)](https://github.com/avast/retry-go/releases/latest)
|
|
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
|
|
[![Travis](https://img.shields.io/travis/avast/retry-go.svg?style=flat-square)](https://travis-ci.org/avast/retry-go)
|
|
[![AppVeyor](https://ci.appveyor.com/api/projects/status/fieg9gon3qlq0a9a?svg=true)](https://ci.appveyor.com/project/JaSei/retry-go)
|
|
[![Go Report Card](https://goreportcard.com/badge/github.com/avast/retry-go?style=flat-square)](https://goreportcard.com/report/github.com/avast/retry-go)
|
|
[![GoDoc](https://godoc.org/github.com/avast/retry-go?status.svg&style=flat-square)](http://godoc.org/github.com/avast/retry-go)
|
|
[![codecov.io](https://codecov.io/github/avast/retry-go/coverage.svg?branch=master)](https://codecov.io/github/avast/retry-go?branch=master)
|
|
[![Sourcegraph](https://sourcegraph.com/github.com/avast/retry-go/-/badge.svg)](https://sourcegraph.com/github.com/avast/retry-go?badge)
|
|
|
|
{{ .EmitSynopsis }}
|
|
|
|
{{ .EmitUsage }}
|
|
|
|
## Contributing
|
|
|
|
Contributions are very much welcome.
|
|
|
|
### Makefile
|
|
|
|
Makefile provides several handy rules, like README.md `generator` , `setup` for prepare build/dev environment, `test`, `cover`, etc...
|
|
|
|
Try `make help` for more information.
|
|
|
|
### Before pull request
|
|
|
|
please try:
|
|
* run tests (`make test`)
|
|
* run linter (`make lint`)
|
|
* if your IDE don't automaticaly do `go fmt`, run `go fmt` (`make fmt`)
|
|
|
|
### README
|
|
|
|
README.md are generate from template [.godocdown.tmpl](.godocdown.tmpl) and code documentation via [godocdown](https://github.com/robertkrimen/godocdown).
|
|
|
|
Never edit README.md direct, because your change will be lost.
|