aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorZachary Scott <mail@zzak.io>2016-08-19 16:17:08 +0900
committerZachary Scott <mail@zzak.io>2016-08-19 16:17:08 +0900
commit7f8804fb34315ddaf47890c527d9341345e0dd02 (patch)
treedca7fc4dc9ad280a0eab32f916441a72f67e3d15 /CONTRIBUTING.md
parentff287a36f3802b652742a942fdc90c7f8474815a (diff)
downloadruby-openssl-7f8804fb34315ddaf47890c527d9341345e0dd02.tar.gz
Fixup Docker and Testing docs
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md30
1 files changed, 23 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 754a1a2b..202c0234 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -36,8 +36,12 @@ Make sure that your branch does:
## Testing
-We have a test suite. Test cases are located under `test/` directory. You can
-run it with the following three commands:
+We have a test suite!
+
+Test cases are located under the
+[`test/`](https://github.com/ruby/openssl/tree/master/test) directory.
+
+You can run it with the following three commands:
```
$ gem install rake-compiler test-unit
@@ -45,11 +49,23 @@ $ rake compile
$ rake test
```
+### Docker
+
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.
+changes work correctly with various supported versions of Ruby and OpenSSL.
+
+First, you need to install [Docker](https://www.docker.com/products/docker) and
+[Docker Compose](https://www.docker.com/products/docker-compose) on your
+computer.
+
+If you're on MacOS or Windows, we recommended to use the official [Docker
+Toolbox](https://www.docker.com/products/docker-toolbox). On Linux, follow the
+instructions for your package manager. For further information, please check
+the [official documentation](https://docs.docker.com/).
-First, you need to install Docker and Docker Compose in your computer. Then,
-running the following commands will work.
+Once you have Docker and Docker Compose, running the following commands will
+build the container and execute the openssl tests. In this example, we will use
+Ruby version 2.3 with OpenSSL version 1.0.2.
```
$ docker-compose build
@@ -61,8 +77,8 @@ $ docker-compose run test
$ docker-compose run debug
```
-The possible values for `RUBY_VERSION` and `OPENSSL_VERSION` can be found in
-`.travis.yml`.
+All possible values for `RUBY_VERSION` and `OPENSSL_VERSION` can be found in
+[`.travis.yml`](https://github.com/ruby/openssl/tree/master/.travis.yml).
## Relation with Ruby source tree