CONTRIBUTING.md

Contributing to Fusuma

1. Fork the repo, develop and test your code changes.
2. Send a pull request.

Setup

In order to use the Fusuma console and run the project's tests, there is a small amount of setup:

1. Install Ruby. Fusuma requires Ruby 2.3+. You may choose to manage your Ruby and gem installations with RVM, rbenv, or chruby.

2. Install Bundler.

   $ gem install bundler

3. Install the top-level project dependencies.

   $ bundle install

Fusuma Tests

Tests are very important part of Fusuma. All contributions should include tests that ensure the contributed code behaves as expected.

To run tests:

$ bundle exec rspec

Fusuma Document

The project uses YARD for generating documentation.

If you're not sure about YARD, please refer to YARD cheatsheet.

To run the Fusuma documentation tests:

$ bundle exec yard --fail-on-warning

To check Fusuma documents with running local server:

$ bundle exec yard server

Then open (http://localhost:8808/)

Coding Style

Please follow the established coding style in the library. The style is is largely based on The Ruby Style Guide.

You can check your code against these rules by running Rubocop like so:

$ bundle exec rubocop

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.