aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorZachary Scott <mail@zzak.io>2016-08-19 16:21:41 +0900
committerZachary Scott <mail@zzak.io>2016-08-19 16:21:41 +0900
commitb537122ce2faa6ab73a9c8a131902e5385fbfe80 (patch)
tree765d90d6e4cfd7f0832339313c35ee5579eedd3f /CONTRIBUTING.md
parent7f8804fb34315ddaf47890c527d9341345e0dd02 (diff)
downloadruby-openssl-b537122ce2faa6ab73a9c8a131902e5385fbfe80.tar.gz
Varify docker-compose configuration and location of Dockerfile
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 202c0234..3aecfaef 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -80,6 +80,16 @@ $ docker-compose run debug
All possible values for `RUBY_VERSION` and `OPENSSL_VERSION` can be found in
[`.travis.yml`](https://github.com/ruby/openssl/tree/master/.travis.yml).
+**NOTE**: these commands must be run from the openssl repository root, in order
+to use the
+[`docker-compose.yml`](https://github.com/ruby/openssl/blob/master/docker-compose.yml)
+file we have provided.
+
+This Docker image is built using the
+[Dockerfile](https://github.com/ruby/openssl/tree/master/tool/ruby-openssl-docker)
+provided in the repository.
+
+
## Relation with Ruby source tree
After Ruby 2.3, `ext/openssl` was converted into a "default gem", a library