community/getting-started.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <!--#include virtual="/inc/head.shtml" -->
   4 <body>
   5   <!--#include virtual="/inc/banner.shtml" -->
   6   <div id="main">
   7     <div id="content">
   8       <div class="blog-index">
   9         <article>
  10           <header><h2>Getting Started as a contributor</h2></header>
  11           <div class="entry-content">
  12             <p>We're always looking for people who want to help out.
  13             Here are some tips to getting started. First, get familiar with
  14             the information on this page, and the links to the side.
  15             In particular, you should look at the <a
  16               href="mailinglists.html">Mailing Lists</a> page and join
  17             the <em>openssl-project</em> or <em>openssl-users</em> list, or both.
  18             After that, here are some ideas:</p>
  19
  20             <ul>
  21
  22               <li><em>Review and comment on the pull requests on GitHub.</em>
  23               <br/>
  24               You can find pull requests -- patches that people have
  25               suggested -- at
  26               <a
  27                 href="https://github.com/openssl/openssl/pulls">https://github.com/openssl/openssl/pulls</a>
  28               Reviewing and commenting on these is helpful and can be a good
  29               way to learn your way around the code.
  30               <p></p></li>
  31
  32               <li><em>Look through the OpenSSL issues on GitHub.</em>
  33               <br/>
  34               You can find issues that people have opened at
  35               <a
  36                 href="https://github.com/openssl/openssl/issues">https://github.com/openssl/openssl/issues</a>.
  37               Sometimes there are open tickets that can be related, it would
  38               be good to cross-reference them (so somebody working on one,
  39               sees the other).  Commentary on the issues is also good.
  40               Even just commenting that you think an issue is important is
  41               very useful!
  42               <p></p></li>
  43
  44               <li><em>Help update the documentation.</em>
  45               <br/>
  46               The documentation has gotten better, but there are still many
  47               API's that are not documented.  Write a POD page, or report
  48               bugs in existing pages.  It's probably better to do a whole
  49               bunch of minor edits in one submission.
  50               <p></p></li>
  51
  52               <li><em>Write some test cases.</em>
  53               <br/>
  54               Simple stand-alone test programs that exercise various API's
  55               are very useful, and can usually be added to our perl-based
  56               test framework pretty easily.
  57               Tests of the command-line program are also important, and
  58               can be handled by the same framework but might require a bit
  59               more digging.  We welcome all new test efforts!
  60               <p></p></li>
  61
  62             </ul>
  63             </p>
  64
  65             <p>Once you've got something ready to contribute, please see
  66             the file CONTRIBUTING in the source.  (TL;DR: Just make
  67             a GitHub pull request :)
  68             </p>
  69           </div>
  70           <footer>
  71             You are here: <a href="/">Home</a>
  72             : <a href=".">Community</a>
  73             : <a href="">Getting Started</a>
  74             <br/><a href="/sitemap.txt">Sitemap</a>
  75           </footer>
  76         </article>
  77       </div>
  78       <!--#include virtual="sidebar.shtml" -->
  79     </div>
  80   </div>
  81 <!--#include virtual="/inc/footer.shtml" -->
  82 </body>
  83 </html>