README.md in ably-rest-1.0.6 vs README.md in ably-rest-1.1.0
- old
+ new
@@ -1,8 +1,7 @@
# [Ably](https://www.ably.io)
-[](https://travis-ci.org/ably/ably-ruby-rest)
[](http://badge.fury.io/rb/ably-rest)
A Ruby REST client library for [www.ably.io](https://www.ably.io), the realtime messaging service.
## Documentation
@@ -140,25 +139,26 @@
## Contributing
Please note that the bulk of this repo is in fact a submodule of the [Ably Ruby REST & Realtime library](https://github.com/ably/ably-ruby). If you want to issue a PR, it is likely you should be looking in that repo to add features or make contributions.
1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Ensure you have added suitable tests and the test suite is passing(`bundle exec rspec`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+2. When pulling to local, make sure to also pull submodules (git submodule init && git submodule update)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Ensure you have added suitable tests and the test suite is passing(`bundle exec rspec`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new Pull Request
## Release Process
-1. `cd` into the [`lib/submodules/ably-ruby`](./lib/submodules/ably-ruby) folder.
-1. Fetch the latest from origin and checkout the [latest `ably-ruby` release tag](https://github.com/ably/ably-ruby/releases) - `git fetch origin && git checkout v1.0.0`
-1. Return the root folder.
-1. Replicate any changes made in [.ably-rest.gemspec](./.ably-rest.gemspec), [.travis.yaml](./.travis.yml) or [spec_helper.rb][./spec/spec_helper.rb] file if applicable and commit those changes.
-1. Run `rake doc:spec` to generate a new [spec file](./SPEC.md).
-1. Commit these changes.
-1. Add a tag and push to origin such as `git tag v1.0.0 && git push origin v1.0.0`
-1. Run `rake release` to publish the gem to [Rubygems](https://rubygems.org/gems/ably-rest)
+1. From the master branch, `cd lib/submodules/ably-ruby`
+2. `git fetch origin && git fetch --tags`
+3. Reset to the tagged version released in ably-ruby, e.g. `git reset v1.0.5 --hard`
+4. Ensure submodules of this submodule are up to date (`git submodule update`)
+5. cd to `ably-ruby-rest`
+6. Stage changes `git add .`
+7. Commit version upgrade (`git commit -m "Version upgrade to v1.0.5"`)
+8. Run `rake release`
See the [Ably Ruby release process notes](https://github.com/ably/ably-ruby#release-process).
## License