Contributing

Everybody is more than welcome to contribute to ruby-ll, no matter how small the change. To keep everything running smoothly there are a few guidelines that one should follow. These are as following:

• When changing code make sure to write RSpec tests for the changes.
• Document code using YARD. At the very least the method arguments and return value(s) should be documented.
• Wrap lines at 80 characters per line.
• Git commits should have a <= 50 character summary, optionally followed by a blank line and a more in depth description of 72 characters per line.

Editor Setup

Whatever editor you use doesn’t matter as long as it can do two things:

• Use spaces for indentation.
• Hard wrap lines at 80 characters per line.

To make this process easier ruby-ll comes with an EditorConfig configuration file. If your editor supports this it will automatically apply the required settings for you.

Hacking on ruby-ll

Assuming you have a local Git clone of ruby-ll, the first step should be to install all the required Gems:

bundle install

Next up, compile the required files and run the tests:

rake

For more information about the available tasks, run rake -T.

Continuous Integration

Two continuous integration services are used to ensure the tests of ruby-ll pass at all times:

• Travis CI: https://travis-ci.org/YorickPeterse/ruby-ll
• AppVeyor (Windows): https://ci.appveyor.com/project/YorickPeterse/ruby-ll

Please note that I will not accept patches that break any tests unless stated otherwise.

Contact

In case you have any further questions or would like to receive feedback before submitting a change, feel free to contact me. You can either open an issue, send a tweet to @yorickpeterse or send an Email to yorickpeterse@gmail.com.