MDArray is part of SciRuby, a collaborative effort to bring scientific computation to Ruby. If you want to help, please do so!
This guide covers ways in which you can contribute to the development of SciRuby and, more specifically, MDArray.
There are various ways to help MDArray: bug reports, coding and documentation. All of them are important.
First, you can help implement new features or bug fixes. To do that, visit our [roadmap] (https://github.com/SciRuby/mdarray/wiki/Roadmap) or our issue tracker. If you find something that you want to work on, post it in the issue or on our mailing list.
You need to send tests together with your code. No exceptions. You can ask for our opinion, but we won't accept patches without good spec coverage.
We use RSpec for testing. If you aren't familiar with it, there's a good guide to better specs with RSpec that shows a bit of the syntax and how to use it properly. However, the best resource is probably the specs that already exist -- so just read them.
And don't forget to write documentation (we use RDoc). It's necessary to allow others to know what's available in the library. There's a section on it later in this guide.
We only accept bug reports and pull requests in GitHub. You'll need to create a new (free) account if you don't have one already. To learn how to create a pull request, please see this guide on collaborating.
If you have a question about how to use MDArray or SciRuby in general or a feature/change in mind, please ask the sciruby-dev mailing list.
Thanks!
You need to clone the git repository:
git clone git://github.com/SciRuby/mdarray.git
cd mdarray
If everything's fine until now, you can create a new branch to work on your feature:
git branch new-feature
git checkout new-feature
Before commiting any code, please read our Contributor Agreement.
There are two ways in which MDArray is being documented: guides and comments, which are converted with RDoc into the documentation seen in sciruby.com.
If you want to write a guide on how to use MDArray to solve some problem or simply showing how to use one of its features, write it as a wiki page and send an e-mail on the mailing list. We're working to improve this process.
If you aren't familiar with RDoc syntax, [this is the official documentation] (http://docs.seattlerb.org/rdoc/RDoc/Markup.html).
This guide was heavily based on the Contributing to Ruby on Rails guide.