Skip to content

Latest commit

 

History

History
63 lines (38 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

63 lines (38 loc) · 3.03 KB
Raw

Contributing guide

Installing daru development dependencies

Either nmatrix or rb-gsl are NOT NECESSARY for using daru. They are just required for an optional speed up and for running the test suite.

To install dependencies, execute the following commands:

  • sudo apt-get update -qq
  • sudo apt-get install -y libgsl0-dev r-base r-base-dev
  • sudo Rscript -e "install.packages(c('Rserve','irr'),,'http://cran.us.r-project.org')"
  • sudo apt-get install libmagickwand-dev imagemagick

Then install remaining dependencies:

bundle install

And run the test suite (should be all green with pending tests):

bundle exec rspec

If you have problems installing nmatrix, please consult the nmatrix installation wiki or the mailing list.

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 - <STDOUT> (Errno::ESPIPE)

To reproduce this issue or explore this error further, head over to issue #500, issue #503. Also, if you want to fix this issue, then please discuss it here : #505

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 <branch_name>.
  2. Make your changes. Write tests covering every case how your feature will be used. If creating new files for tests, refer to the 'Testing' section below.
  3. Try out these changes with rake pry.
  4. Run the test suite with rake spec. (Alternatively you can use guard as described here. Also run Rubocop coding style guidelines with rake cop.
  5. Commit the changes with git commit -am "briefly describe what you did" and submit pull request.

[Optional] You can run rspec for all Ruby versions at once with rake spec run all. But remember to first have all Ruby versions installed with ruby spec setup.

Testing

Daru has automatic testing with Guard. Just execute the following code before you start editting a file and any change you make will trigger the appropriate tests-

guard

NOTE: Please make sure that you place test for your file at the same level and with same itermediatary directories. For example if code file lies in lib/xyz/abc.rb then its corresponding test should lie in spec/xyz/abc_spec.rb. This is to ensure correct working of Guard.

Daru internals

To get an overview of certain internals of daru and their implementation, go over this blog post.