[openssl-commits] [web] master update
Rich Salz
rsalz at openssl.org
Thu Jan 14 19:43:47 UTC 2016
The branch master has been updated
via 9b88450ea84dc68f1c6b761dfa1e1888a5544e78 (commit)
from 90cfda4ce009a0996486f14dd555836ab3b65f52 (commit)
- Log -----------------------------------------------------------------
commit 9b88450ea84dc68f1c6b761dfa1e1888a5544e78
Author: Rich Salz <rsalz at akamai.com>
Date: Thu Jan 14 14:42:24 2016 -0500
Add "getting started" page
Also tweak openssl-commits mailing list description.
-----------------------------------------------------------------------
Summary of changes:
community/getting-started.html | 99 ++++++++++++++++++++++++++++++++++++++++++
community/mailinglists.html | 2 +-
community/sidebar.inc | 3 ++
index.html | 7 +--
4 files changed, 107 insertions(+), 4 deletions(-)
create mode 100644 community/getting-started.html
diff --git a/community/getting-started.html b/community/getting-started.html
new file mode 100644
index 0000000..158fa71
--- /dev/null
+++ b/community/getting-started.html
@@ -0,0 +1,99 @@
+<!DOCTYPE html>
+<html lang="en">
+<!--#include virtual="/inc/head.inc" -->
+<body>
+ <!--#include virtual="/inc/banner.inc" -->
+ <div id="main">
+ <div id="content">
+ <div class="blog-index">
+ <article>
+ <header><h2>Getting Started as a contributor</h2></header>
+ <div class="entry-content">
+ <p>We're always looking for people who want to help out.
+ Here are some tips to getting started. First, get familiar with
+ the information on this page, and the links to the side.
+ In particular, you should look at the <a
+ href="mailinglists.html">Mailing Lists</a> page and join
+ the <em>openssl-dev</em> or <em>openssl-users</em> list, or both.
+ After that, here are some ideas:</p>
+
+ <ul>
+ <li><em>Look through the open tickets on our ticket system.</em>
+ <br/>
+ <a
+ href="https://rt.openssl.org/NoAuth/Login.html?user=guest&password=guest">https://rt.openssl.org/NoAuth/Login.html?user=guest&password=guest</a>.
+ Scan old tickets and offer patches, suggestions on how to
+ help fix, or even just point out which ones can be closed.
+ You won't be able to edit anything through this interface,
+ so if you want to give information on a bug (say it's number
+ 1234) then send mail to the openssl-dev mailing list, and
+ put this text at the start of the Subject line: "[openssl.org
+ #1234]" followed by your text. Plaintext (non-HTML) messages
+ are best. Attachments, such as a proposed patch, are fine.
+ That special subject-line prefix will get your message
+ connected into the ticket log.
+ <p></p></li>
+
+ <li><em>Look through the OpenSSL issues on GitHub.</em>
+ <br/>
+ You can find issues that people have opened at
+ <a
+ href="https://github.com/openssl/openssl/issues">https://github.com/openssl/openssl/issues</a>.
+ Sometimes there are open tickets that can be related, it would
+ be good to cross-reference them (so somebody working on one,
+ sees the other). Commentary on the issues is also good,
+ particularly when an issue should instead by a bug report
+ (RT ticket). Open an RT (email to rt at openssl.org) and reference
+ the GitHub issue and then when the ticket is created, update
+ the issue with the ticket number. Again, the whole point is
+ to tie issues, PR's, and tickets together so that closing one
+ will lead to all the related ones.
+ Even just commenting that you think an issue is important is
+ very useful!
+ <p></p></li>
+
+ <li><em>Look at the pull requests on GitHub.</em>
+ <br/>
+ You can find pull requests -- patches that people have
+ suggested -- at
+ <a
+ href="https://github.com/openssl/openssl/pulls">https://github.com/openssl/openssl/pulls</a>
+ Reviewing and commenting on these is helpful, like with
+ the issues mentioned above.
+ <p></p></li>
+
+ <li><em>Help update the documentation.</em>
+ <br/>
+ The documentation has gotten better, but there are still many
+ API's that are not documented. Write a POD page, or report
+ bugs in existing pages. It's probably better to get a whole
+ bunch of minor edits done one once.
+ <p></p></li>
+
+ <li><em>Write some test cases.</em>
+ <br/>
+ Simple stand-alone test programs that exercise various API's
+ are very useful, and can usually be added to our perl-based
+ test framework pretty easily.
+ Tests of the command-line program are also important, and
+ can be handled by the same framework but might require a bit
+ more digging. We welcome all new test efforts!
+ <p></p></li>
+
+ </ul>
+ </p>
+ </div>
+ <footer>
+ You are here: <a href="/">Home</a>
+ : <a href=".">Community</a>
+ : <a href="">Getting Started</a>
+ <br/><a href="/sitemap.txt">Sitemap</a>
+ </footer>
+ </article>
+ </div>
+ <!--#include virtual="sidebar.inc" -->
+ </div>
+ </div>
+<!--#include virtual="/inc/footer.inc" -->
+</body>
+</html>
diff --git a/community/mailinglists.html b/community/mailinglists.html
index d7b6314..1ffb8b0 100644
--- a/community/mailinglists.html
+++ b/community/mailinglists.html
@@ -27,7 +27,7 @@
<tr>
<td><a
href="https://mta.openssl.org/mailman/listinfo/openssl-commits">openssl-commits</a></td>
- <td>Commits to the source repository; read-only</td>
+ <td>Commits to the source repository and build results; read-only.</td>
</tr>
<tr>
<td><a
diff --git a/community/sidebar.inc b/community/sidebar.inc
index 2049ccc..bbbe84b 100644
--- a/community/sidebar.inc
+++ b/community/sidebar.inc
@@ -13,6 +13,9 @@
<a href="contacts.html">Contact Us</a>
</li>
<li>
+ <a href="getting-started.html">Getting Started as a Contributor</a>
+ </li>
+ <li>
<a href="thanks.html">Thanks!</a>
</li>
<li>
diff --git a/index.html b/index.html
index b2620f5..d1cfe46 100644
--- a/index.html
+++ b/index.html
@@ -9,7 +9,7 @@
<div id="content">
<div class="blog-index">
<article>
- <header><h2>Welcome OpenSSL</h2></header>
+ <header><h2>Welcome to OpenSSL!</h2></header>
<div class="entry-content">
<p>
OpenSSL is an open source project that provides a
@@ -17,8 +17,9 @@
for the Transport Layer Security (TLS) and Secure
Sockets Layer (SSL) protocols. It is also a general-purpose
cryptography library. For more information about the
- team and community around the project, start with the
- <a href="/community">community</a> page. To get the
+ team and community around the project, or to start making
+ your own contributions, start with the
+ <a href="/community">community</a> page. To get the
latest news, download the source, and so on, please see
the sidebar or the buttons at the top of every page.
</p>
More information about the openssl-commits
mailing list