Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 1.46 KB

Thank you for thinking about contributing something to TruffleRuby!

Building

See the building instructions to build TruffleRuby from source.

Contributor Agreement

You will need to sign the Oracle Contributor Agreement (using an online form) for us to able to review and merge your work.

See Contribute to GraalVM for more details.

We also have a code of conduct for contributors.

Contributor Documentation

And finally, we have some more technical contributor documentation, which might be useful to someone working on TruffleRuby.

https://github.com/oracle/truffleruby/tree/master/doc/contributor

Slack

You are welcome to join the channel #truffleruby of the GraalVM Slack for any help related to contributing to TruffleRuby.

Style

We use various lint tools to keep the style consistent. The most important checks can be run locally with jt lint fast. You can use tool/hooks/lint-check.sh as a git hook to run jt lint fast automatically, see instructions in that file.

ChangeLog

When opening a Pull Request, please add a ChangeLog entry with the format:

* Description (#PR number, @author).

See the the ChangeLog for examples.