README.md in cinnamon_serial-2.1.0 vs README.md in cinnamon_serial-2.1.1
- old
+ new
@@ -1,8 +1,8 @@
# Cinnamon Serial
-[](https://travis-ci.org/bluemarblepayroll/cinnamon_serial)
+[](https://badge.fury.io/rb/cinnamon_serial) [](https://travis-ci.org/bluemarblepayroll/cinnamon_serial) [](https://codeclimate.com/github/bluemarblepayroll/cinnamon_serial/maintainability) [](https://codeclimate.com/github/bluemarblepayroll/cinnamon_serial/test_coverage) [](https://opensource.org/licenses/MIT)
A common issue is that we typically want different data going
outbound than what we have available server-side. Some example motivations could be:
* I have too much data, I want to slim down the outbound request.
@@ -202,11 +202,39 @@
### Running Tests
To execute the test suite run:
````
-rspec
+bundle exec rspec spec --format documentation
````
+
+Alternatively, you can have Guard watch for changes:
+
+````
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````
+bundle exec rubocop
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into master
+2. Update ```lib/cinnamon_serial/version.rb``` using [semantic versioning](https://semver.org/)
+3. Install dependencies: ```bundle```
+4. Update ```CHANGELOG.md``` with release notes
+5. Commit & push master to remote and ensure CI builds master successfully
+6. Build the project locally: `gem build cinnamon_serial`
+7. Publish package to RubyGems: `gem push cinnamon_serial-X.gem` where X is the version to push
+8. Tag master with new version: `git tag <version>`
+9. Push tags remotely: `git push origin --tags`
## License
This project is MIT Licensed.