Gem and Subproject Checklist

This document describes what your gem or subproject needs in order to be promoted as an official SciRuby library.

Your subproject or gem:

• Should utilize semantic versioning, unless alpha status. NMatrix uses the following scheme:
  • 0.0.x for the initial alpha releases (subsequent may use
  • 0.1.0 for the initial beta release
  • the suffix .rc? for release candidates (e.g., 0.1.0.rc1 for the first beta release candidate)
  • 1.0.0 will be the initial full release
• Must be licensed under BSD 3-clause, MIT license, public domain, or compatible. We strongly recommend using BSD 3-clause for consistency. Other licenses may be considered. GPL is not permissible.
• Should support RDoc for documentation. YARD is also acceptable, but we note that RDoc is YARD-compatible.
• The readme (see example)
• Should be in RDoc format
• Should be named README.rdoc
• Must include a link to sciruby.com
• At the end of the Description, must include a statement kind of like this one: "Plotrb was created by Wan Zuhao as part of Google’s Summer of Code 2013. It is part of SciRuby." Obviously, remove the part about GSOC if that doesn't apply to you.
• Should include the following sections or their rough equivalents: Description, Installation, Usage, Contributing.
• Must include a Contributing section like the one used by NMatrix.
• Must include a License section like the one used by NMatrix. It needs to grant joint copyright to the author and the Ruby Science Foundation, or just to RSF if you prefer.
• Must include a LICENSE.txt file exactly like the one from NMatrix, except with the project name changed, and including the text of your selected license.
• May include a CONTRIBUTING.md file like this one, if long, or otherwise must include the relevant information in that section of the README.
• If it includes a Citing section (e.g., Biogem-style), it must include a link to the SciRuby citation instructions: http://sciruby.com/publications/
  • If you have a publication which you want listed in the Citation instructions at sciruby.com, please email them to sciruby dot project at gmail dot com.
• Must be kept up-to-date in the SciRuby github account once included. The issues tracker should be kept in the SciRuby account as well, e.g., at https://github.com/SciRuby/yourgem/issues.
• Should be compatible with NMatrix if implemented for use with MRI/YARV.
• Should be compatible with MDArray if implemented for use with JRuby.

While not required, it is suggested that your project

• Should adhere to the Ruby style guide utilized by Rubocop.

Draft status

This is a draft.