diff options
| -rw-r--r-- | CONTRIBUTING.md | 53 | ||||
| -rw-r--r-- | README.md | 21 |
2 files changed, 48 insertions, 26 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a903b5e2..d230bda1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,34 +1,38 @@ # Contributing to Ruby OpenSSL -Thank you for your interest in contributing to Ruby OpenSSL! This documentation -provides an overview how to contribute. +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 issue here, there is a separate procedure. +security issues here, there is a separate procedure which is described on +["Security at ruby-lang.org"](https://www.ruby-lang.org/en/security/). When reporting a bug, please make sure you include the version of Ruby, the -version of openssl gem, the version of OpenSSL, and a sample file that -illustrates the problem, link to the repository or gem that is associated with -the bug. +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 former issue tracker. +[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: +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 -* Add an entry to NEWS if necessary +* Pass the test suite successfully (see "Testing") +* Add an entry to [History.rdoc] if necessary ## Testing @@ -40,14 +44,14 @@ $ rake compile $ rake test ``` -Test cases are located under test/ directory. +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 ships -with standard Ruby builds but can be upgraded via RubyGems. This means the -development of openssl has been migrated to a separate repository (this!) and -will be released independently. +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][GitHub] and will be released independently. The version included in the Ruby source tree (trunk branch) is synchronized with the latest release. @@ -55,22 +59,29 @@ the latest release. ## Release policy Bug fixes (including security fixes) will be made only for the version series -included in a Ruby release. +included in a stable Ruby release. ## Security -If you feel 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 security@ruby-lang.org. Please see [Security] -page on ruby-lang.org website for details. Reported problems will be published -after fixes. +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 security@ruby-lang.org. + +Please see [Security] page on ruby-lang.org website for details. + +Reported problems will be published after a fix is released. Thank you for your contributions! +- The Ruby OpenSSL Team + [GitHub]: https://github.com/ruby/openssl [known issues]: https://github.com/ruby/openssl/issues [bugs.ruby-lang.org]: https://bugs.ruby-lang.org/issues?utf8=%E2%9C%93&set_filter=1&f%5B%5D=status_id&op%5Bstatus_id%5D=o&f%5B%5D=assigned_to_id&op%5Bassigned_to_id%5D=%3D&v%5Bassigned_to_id%5D%5B%5D=7150&f%5B%5D=&c%5B%5D=project&c%5B%5D=tracker&c%5B%5D=status&c%5B%5D=subject&c%5B%5D=assigned_to&c%5B%5D=updated_on&group_by=&t%5B%5D= [DeveloperHowTo]: https://bugs.ruby-lang.org/projects/ruby/wiki/DeveloperHowto [HackerOne]: https://hackerone.com/ruby [Security]: https://www.ruby-lang.org/en/security/ +[pull request]: https://github.com/ruby/openssl/compare +[History.rdoc]: https://github.com/ruby/openssl/tree/master/History.rdoc @@ -20,16 +20,27 @@ You may need to specify the path where OpenSSL is installed. gem install openssl -- --with-openssl-dir=/opt/openssl ``` +Alternatively, you can install the gem with `bundler`: + +```ruby +# Gemfile +gem 'openssl' +# or specify git master +gem 'openssl', github: 'ruby/openssl' +``` + +After doing `bundle install`, you should have the gem installed in your bundle. + ## Usage -After you install it, you can require "openssl" in your application. +Once installed, you can require "openssl" in your application. ```ruby require "openssl" ``` -If you are using Ruby 2.3, you may need to tell RubyGems to prefer the gem -version of openssl. +If you are using Ruby 2.3, you may activate the gem version of openssl, +instead of using the default gem packaged with the Ruby installation. ```ruby gem "openssl" @@ -51,5 +62,5 @@ Please read CONTRIBURING.md for instructions. ## Security -Security issues should be reported following the process described in the -[Security page on ruby-lang.org](https://www.ruby-lang.org/en/security/). +Security issues should be reported to ruby-core by following the process +described on ["Security at ruby-lang.org"](https://www.ruby-lang.org/en/security/). |