README.md in sandboxy-3.0.1 vs README.md in sandboxy-3.0.2
- old
+ new
@@ -1,9 +1,7 @@
# Sandboxy
-[](https://badge.fury.io/rb/sandboxy) 
-
Sandboxy allows you to use virtual data-oriented environments inside a Rails application while being able to switch between them at runtime. It achieves that by using a combination of Rack Middleware and ActiveRecord.
---
## Table of Contents
@@ -15,15 +13,13 @@
* [Switching environments](#switching-environments)
* [Sandbox & APIs](#sandbox--apis)
* [Configuration](#configuration)
* [Testing](#testing)
* [Test Coverage](#test-coverage)
-* [To do](#to-do)
+* [Release](#release)
* [Contributing](#contributing)
- * [Contributors](#contributors)
* [Semantic versioning](#semantic-versioning)
-* [License](#license)
---
## Installation
@@ -159,15 +155,19 @@
1. Fork this repository
2. Clone your forked git locally
3. Install dependencies
+ ```
$ bundle install
+ ```
4. Run tests
- $ rake test
+ ```
+ $ bundle exec rake test
+ ```
### Test Coverage
Test coverage can be calculated using SimpleCov. Make sure you have the [simplecov gem](https://github.com/colszowka/simplecov) installed.
@@ -177,14 +177,17 @@
$ rake test
---
-## To do
+## Release
-We use [GitHub projects](https://github.com/jonhue/sandboxy/projects/1) to coordinate the work on this project.
-
-To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/sandboxy/issues/new).
+1. Review breaking changes and deprecations in `CHANGELOG.md`
+2. Change the gem version in `lib/sandboxy/version.rb`
+3. Reset `CHANGELOG.md`
+4. Create a pull request to merge the changes into `master`
+5. After the pull request was merged, create a new release listing the breaking changes and commits on `master` since the last release.
+6. The release workflow will publish the gems to RubyGems and the GitHub Package Registry
---
## Contributing