From 038fd578e83ccb19f7e60af77ec1f11c805bf364 Mon Sep 17 00:00:00 2001 From: Kamil Samigullin Date: Tue, 10 Oct 2017 14:31:30 +0300 Subject: [PATCH] fix issue #86: update github-tpl --- .github/CODE_OF_CONDUCT.md | 5 +++++ .github/CONTRIBUTING.md | 28 ++++++++++++++++++++++++ README.md | 44 +++++--------------------------------- 3 files changed, 38 insertions(+), 39 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..8ffc1c6 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,5 @@ +# Code of Conduct + +The project team follows [Contributor Covenant v1.4](http://contributor-covenant.org/version/1/4/). +Instances of abusive, harassing or otherwise unacceptable behavior may be reported by contacting +the project team at feedback@octolab.org. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..948d6a8 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing workflow + +Read first [Go Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments). + +## Code quality checking + +```bash +$ make docker-pull-tools +$ make check-code-quality +``` + +## Testing + +### Local + +```bash +$ make install-deps +$ make test # or test-with-coverage +$ make bench +``` + +### Docker + +```bash +$ make docker-pull +$ make complex-tests # or (complex|parallel)-tests-with-coverage +$ make complex-bench +``` diff --git a/README.md b/README.md index ea2c18d..8b9a215 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,6 @@ [![GoDoc](https://godoc.org/github.com/kamilsk/retry?status.svg)](https://godoc.org/github.com/kamilsk/retry) [![License](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](LICENSE) -## Code of Conduct - -The project team follows [Contributor Covenant v1.4](http://contributor-covenant.org/version/1/4/). -Instances of abusive, harassing or otherwise unacceptable behavior may be reported by contacting -the project team at feedback@octolab.org. - ---- - ## Differences from [Rican7/retry](https://github.com/Rican7/retry) - Fixed [bug](https://github.com/Rican7/retry/pull/2) with an unexpected infinite loop. @@ -32,7 +24,7 @@ the project team at feedback@octolab.org. ## Installation ```bash -$ egg github.com/kamilsk/retry +$ go get github.com/kamilsk/retry ``` ### Mirror @@ -45,37 +37,10 @@ $ egg bitbucket.org/kamilsk/retry ### Update -This library is using [SemVer](http://semver.org) for versioning and it is not +This library is using [SemVer](http://semver.org) for versioning, and it is not [BC](https://en.wikipedia.org/wiki/Backward_compatibility)-safe. Therefore, do not use `go get -u` to update it, use [Glide](https://glide.sh) or something similar for this purpose. -## Contributing workflow - -### Code quality checking - -```bash -$ make docker-pull-tools -$ make check-code-quality -``` - -### Testing - -#### Local - -```bash -$ make install-deps -$ make test # or test-with-coverage -$ make bench -``` - -#### Docker - -```bash -$ make docker-pull -$ make complex-tests # or complex-tests-with-coverage -$ make complex-bench -``` - ## Feedback [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/kamilsk/retry) @@ -83,5 +48,6 @@ $ make complex-bench ## Notes -- tested on Go 1.7 and 1.8, use 1.x version for 1.5 and 1.6 -- [research](RESEARCH.md) +- tested on Go 1.5, 1.6, 1.7, 1.8 and 1.9 +- [research](../../tree/research) +- made with ❤️ by [OctoLab](http://www.octolab.org)