README.md in octokit-4.14.0 vs README.md in octokit-4.15.0
- old
+ new
@@ -39,11 +39,12 @@
1. [Upgrading from 1.x.x](#upgrading-from-1xx)
13. [Advanced usage](#advanced-usage)
1. [Debugging](#debugging)
2. [Caching](#caching)
14. [Hacking on Octokit.rb](#hacking-on-octokitrb)
- 1. [Running and writing new tests](#running-and-writing-new-tests)
+ 1. [Code of Conduction](#code_of_conduct)
+ 2. [Running and writing new tests](#running-and-writing-new-tests)
15. [Supported Ruby Versions](#supported-ruby-versions)
16. [Versioning](#versioning)
17. [Making Repeating Requests](#making-repeating-requests)
18. [License](#license)
@@ -61,11 +62,11 @@
# Fetch a README with Accept header for HTML format
client.readme 'al3x/sovereign', :accept => 'application/vnd.github.html'
```
[wrappers]: http://wynnnetherland.com/journal/what-makes-a-good-api-wrapper
-[github-api]: http://developer.github.com
+[github-api]: https://developer.github.com/v3/
## Quick start
Install via Rubygems
@@ -287,11 +288,11 @@
previous, and last pages for you in the `Link` response header as [Hypermedia
link relations](#hypermedia-agent).
```ruby
issues = client.issues 'rails/rails'
-issues.concat client.last_response.rels[:next].get.data
+issues.concat client.get(client.last_response.rels[:next].href)
```
### Auto pagination
For smallish resource lists, Octokit provides auto pagination. When this is
@@ -651,10 +652,16 @@
script/console
Using the scripts in `./scripts` instead of `bundle exec rspec`, `bundle
console`, etc. ensures your dependencies are up-to-date.
+### Code of Conduct
+
+We want both the Octokit.rb and larger Octokit communities to be an open
+and welcoming environments. Please read and follow both in spirit and
+letter [Code of Conduct](CODE_OF_CONDUCT.md).
+
### Running and writing new tests
Octokit uses [VCR][] for recording and playing back API fixtures during test
runs. These cassettes (fixtures) are part of the Git project in the `spec/cassettes`
folder. If you're not recording new cassettes you can run the specs with existing
@@ -750,10 +757,10 @@
[semver]: http://semver.org/
[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
[releases]: https://github.com/octokit/octokit.rb/releases
## Making Repeating Requests
-In most cases it would be best to use a [webhooks](https://developer.github.com/webhooks/), but sometimes webhooks don't provide all of the information needed. In those cases where one might need to poll for progress or retry a request on failure, we designed [Octopoller](https://github.com/octokit/octopoller.rb). Octopoller is a micro gem perfect for making repeating requests.
+In most cases it would be best to use a [webhooks](https://developer.github.com/webhooks/), but sometimes webhooks don't provide all of the information needed. In those cases where one might need to poll for progress or retry a request on failure, we designed [Octopoller](https://github.com/octokit/octopoller.rb). Octopoller is a micro gem perfect for making repeating requests.
```ruby
Octopoller.poll(timeout: 15.seconds) do
begin
client.request_progress # ex. request a long running job's status