From dea4055dab9df1371f05a71ec7b137a4dac45521 Mon Sep 17 00:00:00 2001 From: Sylfrena Date: Fri, 29 Mar 2019 04:22:21 +0530 Subject: [PATCH] Add troubleshooting to docs for higher Ruby versions --- .gitignore | 1 + CONTRIBUTING.md | 9 +++++++++ 2 files changed, 10 insertions(+) diff --git a/.gitignore b/.gitignore index 3d34f444a..6809a4f30 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ doc/ vendor/ profile/out/ coverage/ +.ruby-version diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9eaafc29a..72a5906e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,12 +22,21 @@ And run the test suite (should be all green with pending tests): If you have problems installing nmatrix, please consult the [nmatrix installation wiki](https://github.com/SciRuby/nmatrix/wiki/Installation) or the [mailing list](https://groups.google.com/forum/#!forum/sciruby-dev). +**NOTE**: `Daru` is compatible with Ruby versions < 2.5; for later Ruby versions it breaks, returning the following error in versions >= 2.5. +``` +/gems/packable-1.3.10/lib/packable/extensions/io.rb:86:in `pos': Illegal seek @ rb_io_tell - (Errno::ESPIPE) +``` +To reproduce this issue or explore this error further, head over to +[issue #500](https://github.com/SciRuby/daru/issues/500), +[issue #503](https://github.com/SciRuby/daru/issues/503). Also, if you want to fix this issue, then please discuss it here : [#505](https://github.com/SciRuby/daru/issues/500) + While preparing your pull requests, don't forget to check your code with Rubocop: `bundle exec rubocop` [Optional] Install all Ruby versions which Daru currently supports with `rake spec setup`. + ## Basic Development Flow 1. Create a new branch with `git checkout -b `.