Skip to content

Commit

Permalink
fix issue #86: update github-tpl
Browse files Browse the repository at this point in the history
  • Loading branch information
kamilsk committed Oct 10, 2017
1 parent 08736cd commit 038fd57
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 39 deletions.
5 changes: 5 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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.
28 changes: 28 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
```
44 changes: 5 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -45,43 +37,17 @@ $ 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)
[![@ikamilsk](https://img.shields.io/badge/author-%40ikamilsk-blue.svg)](https://twitter.com/ikamilsk)

## 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)

0 comments on commit 038fd57

Please sign in to comment.