39 lines
1.6 KiB
Cheetah
39 lines
1.6 KiB
Cheetah
|
# {{ .Name }}
|
||
|
|
|
||
|
|
[](https://github.com/avast/retry-go/releases/latest)
|
||
|
|
[](LICENSE.md)
|
||
|
|
|
||
|
|
[](https://goreportcard.com/report/github.com/avast/retry-go)
|
||
|
|
[](http://godoc.org/github.com/avast/retry-go)
|
||
|
|
[](https://codecov.io/github/avast/retry-go?branch=master)
|
||
|
|
[](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
|
||
|
|
|
||
|
|
> maybe you need `make setup` in order to setup environment
|
||
|
|
|
||
|
|
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.
|