README.md in conferrable-1.0.3 vs README.md in conferrable-1.0.4
- old
+ new
@@ -1,8 +1,8 @@
# Conferrable
-[](https://travis-ci.org/bluemarblepayroll/conferrable)
+[](https://badge.fury.io/rb/conferrable) [](https://travis-ci.org/bluemarblepayroll/conferrable) [](https://codeclimate.com/github/bluemarblepayroll/conferrable/maintainability) [](https://codeclimate.com/github/bluemarblepayroll/conferrable/test_coverage) [](https://opensource.org/licenses/MIT)
We have seen our applications gain more and more static configuration files over time. A common library we use on a daily basis is these configuration file loaders. Conferrable standardizes how we interact with these static YAML configuration files. It offers a simple and extendable API for dealing with the following scenarios:
* Load a YAML file
* Load a directory of YAML files
@@ -85,11 +85,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/conferrable/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 conferrable`
+7. Publish package to RubyGems: `gem push conferrable-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.