aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorKazuki Yamaguchi <k@rhe.jp>2016-08-18 21:51:51 +0900
committerKazuki Yamaguchi <k@rhe.jp>2016-08-18 21:51:51 +0900
commitff287a36f3802b652742a942fdc90c7f8474815a (patch)
tree995d5e61e02beea631064a8e462a4b71adbea3c2 /CONTRIBUTING.md
parent1bdd3d34afacf26caa567c3adbf4ddca840d82d9 (diff)
downloadruby-openssl-ff287a36f3802b652742a942fdc90c7f8474815a.tar.gz
Add instructions for running tests under Docker in CONTRIBUTING.md
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f4c9319b..754a1a2b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -36,7 +36,8 @@ Make sure that your branch does:
## Testing
-We have a test suite. You can run it with the following three commands:
+We have a test suite. Test cases are located under `test/` directory. You can
+run it with the following three commands:
```
$ gem install rake-compiler test-unit
@@ -44,7 +45,24 @@ $ rake compile
$ rake test
```
-Test cases are located under `test/` directory.
+You can also use Docker Compose to run tests. It can be used to check that your
+changes works correctly with various supported versions of Ruby and OpenSSL.
+
+First, you need to install Docker and Docker Compose in your computer. Then,
+running the following commands will work.
+
+```
+$ docker-compose build
+$ export RUBY_VERSION=ruby-2.3
+$ export OPENSSL_VERSION=openssl-1.0.2
+$ docker-compose run test
+
+# You may want an interactive shell for dubugging
+$ docker-compose run debug
+```
+
+The possible values for `RUBY_VERSION` and `OPENSSL_VERSION` can be found in
+`.travis.yml`.
## Relation with Ruby source tree