diff options
| author | ahadc <ahadc@sfu.ca> | 2018-03-24 19:02:45 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-03-24 19:02:45 -0700 |
| commit | 51181247a238b1fb148dad15b6fd2fa1471fc06e (patch) | |
| tree | 6c1f5f01480a6990e2a91f22695ff94406d40b0b | |
| parent | 5c5bf71394b286698956438a3694b71640d6895b (diff) | |
| download | ruby-openssl-51181247a238b1fb148dad15b6fd2fa1471fc06e.tar.gz | |
Update CONTRIBUTING.md
Created a list format for the items required for a bug report.
Also fixed a minor grammatical issue in the paragraph below the list.
| -rw-r--r-- | CONTRIBUTING.md | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e6e2a54..89f7e1d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,12 +12,14 @@ 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"](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 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 +When reporting a bug, please make sure you include: +* Ruby version +* OpenSSL gem version +* OpenSSL library version +* A sample file that illustrates the problem or link to the repository or + gem that is associated with the bug. + +There are 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. |