diff options
author | Kazuki Yamaguchi <k@rhe.jp> | 2016-08-17 17:14:09 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-08-17 17:14:09 +0900 |
commit | 1bdd3d34afacf26caa567c3adbf4ddca840d82d9 (patch) | |
tree | 9a15d5d10b30adcd257a91710dcdec276002c4dc | |
parent | 580c6d4a51d7a8713e46b06474341e1297d4de13 (diff) | |
parent | e80d4ba1aa66214f34e820e53ba41b4f10821886 (diff) | |
download | ruby-openssl-1bdd3d34afacf26caa567c3adbf4ddca840d82d9.tar.gz |
Merge pull request #67 from zzak/readme-contrib-docs
Readme contrib docs
-rw-r--r-- | CONTRIBUTING.md | 54 | ||||
-rw-r--r-- | README.md | 27 |
2 files changed, 53 insertions, 28 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a903b5e2..f4c9319b 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,18 +59,22 @@ 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. +_Thanks for your contributions!_ -Thank you for your contributions! + _\- The Ruby OpenSSL team_ [GitHub]: https://github.com/ruby/openssl [known issues]: https://github.com/ruby/openssl/issues @@ -74,3 +82,5 @@ Thank you for your contributions! [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,28 @@ 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. +**NOTE**: If you are using Ruby 2.3 (and not Bundler), you **must** activate +the gem version of openssl, otherwise the default gem packaged with the Ruby +installation will be used: ```ruby gem "openssl" @@ -47,9 +59,12 @@ and the official [OpenSSL library](http://www.openssl.org/). ## Contributing -Please read CONTRIBURING.md for instructions. +Please read our [CONTRIBUTING.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/). + + +[CONTRIBUTING.md]: https://github.com/ruby/openssl/tree/master/CONTRIBUTING.md |