Skip to content

Commit e4177dc

Browse files
hlovdalianfixes
authored andcommitted
Updated CONTRIBUTING.md with dev env information
1 parent afda850 commit e4177dc

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

+16
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,23 @@ Pull requests will trigger a Travis CI job. The following two commands will be
1212
* `rubocop -D` - code style tests
1313
* `rspec` - functional tests
1414

15+
If you do not already have a working ruby development environment set up, run the following commands:
16+
17+
```shell
18+
apt-get install ruby ruby-dev # For Debian/Ubuntu
19+
dnf install ruby ruby-devel # For Fedora
20+
yum install ruby ruby-devel # For Centos/RHEL
21+
gem install bundler # See note below about version
22+
gem install rubocop
23+
gem install rspec
24+
```
25+
26+
As of writing this you want install a version 1 of bundler, `gem install bundler -v '1.17.3'`,
27+
since there is some incompability with regards to the
28+
[latest version 2 release of bundler](https://bundler.io/blog/2019/01/04/an-update-on-the-bundler-2-release.html)
29+
1530
Be prepared to write tests to accompany any code you would like to see merged.
31+
See `SampleProjects/TestSomething/test/*.cpp` for the existing tests (run by rspec).
1632

1733

1834
## Packaging the Gem

0 commit comments

Comments
 (0)