Skip to content

Latest commit

 

History

History
88 lines (59 loc) · 1.93 KB

README.adoc

File metadata and controls

88 lines (59 loc) · 1.93 KB
Raw

Expressir: EXPRESS in Ruby

ubuntu macos windows

Purpose

Ruby binding for the OGDF diagram library.

Development

We are following Sandi Metz’s Rules for this gem, you can read the description of the rules here All new code should follow these rules. If you make changes in a pre-existing file that violates these rules you should fix the violations as part of your contribution.

Setup

Clone the repository.

git clone https://github.com/lutaml/ruby-ogdf

Setup your environment.

bin/setup

Run the test suite

bin/rspec

Installation

Add this line to your application’s Gemfile:

gem "ogdf"

And then execute:

$ bundle install

Or install it yourself as:

$ gem install ogdf

Contributing

First, thank you for contributing! We love pull requests from everyone. By participating in this project, you hereby grant Ribose Inc. the right to grant or transfer an unlimited number of non exclusive licenses or sub-licenses to third parties, under the copyright covering the contribution to use the contribution by all means.

Here are a few technical guidelines to follow:

  • Open an issues to discuss a new feature.

  • Write tests to support your new feature.

  • Make sure the entire test suite passes locally and on CI.

  • Open a Pull Request.

  • Squash your commits after receiving feedback.

  • Party!

License

Ruby-OGDF is distributed under the BSD 2-clause license.