Skip to content

Latest commit

 

History

History
86 lines (57 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

86 lines (57 loc) · 3.06 KB

Contributing to Ruby OpenSSL

Thank you for your interest in contributing to Ruby OpenSSL!

This documentation provides an overview how you can contribute.

Bugs and feature requests

Bugs and feature requests are tracked on GitHub.

If you think you found a bug, file a ticket on GitHub. Please DO NOT report security issues here, there is a separate procedure which is described on "Security at ruby-lang.org".

When reporting a bug, please make sure you include the version of Ruby, the version of openssl gem, the version of the OpenSSL library, along with a sample file that illustrates the problem or link to repository or gem that is associated with the bug.

There is a number of unresolved issues and feature requests for openssl that need review. Before submitting a new ticket, it is recommended to check known issues and bugs.ruby-lang.org, the previous issue tracker.

Submitting patches

Patches are also very welcome!

Please submit a pull request with your changes.

Make sure that your branch does:

  • Have good commit messages
  • Follow Ruby's coding style (DeveloperHowTo)
  • Pass the test suite successfully (see "Testing")
  • Add an entry to History.rdoc if necessary

Testing

We have a test suite. You can run it with the following three commands:

$ gem install rake-compiler test-unit
$ rake compile
$ rake test

Test cases are located under test/ directory.

Relation with Ruby source tree

After Ruby 2.3, ext/openssl was converted into a "default gem", a library which ships with standard Ruby builds but can be upgraded via RubyGems. This means the development of this gem has migrated to a separate repository and will be released independently.

The version included in the Ruby source tree (trunk branch) is synchronized with the latest release.

Release policy

Bug fixes (including security fixes) will be made only for the version series included in a stable Ruby release.

Security

If you discovered a security issue, please send us in private, using the security issue handling procedure for Ruby core.

You can either use HackerOne or send an email to [email protected].

Please see Security page on ruby-lang.org website for details.

Reported problems will be published after a fix is released.

Thanks for your contributions!

- The Ruby OpenSSL team