| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| |
| <link rel="shortcut icon" href="../favicon.ico" type="image/x-icon"> |
| <link rel="icon" href="../favicon.ico" type="image/x-icon"> |
| |
| <title>Contributing</title> |
| |
| <!-- Bootstrap core CSS --> |
| <link href="../assets/css/bootstrap.min.css" rel="stylesheet"> |
| <!-- Bootstrap theme --> |
| <link href="../assets/css/bootstrap-theme.min.css" rel="stylesheet"> |
| |
| <!-- Custom styles for this template --> |
| <link rel="stylesheet" href="https://fortawesome.github.io/Font-Awesome/assets/font-awesome/css/font-awesome.css"> |
| <link href="../css/style.css" rel="stylesheet"> |
| <link href="../assets/css/owl.theme.css" rel="stylesheet"> |
| <link href="../assets/css/owl.carousel.css" rel="stylesheet"> |
| <script type="text/javascript" src="../assets/js/jquery.min.js"></script> |
| <script type="text/javascript" src="../assets/js/bootstrap.min.js"></script> |
| <script type="text/javascript" src="../assets/js/owl.carousel.min.js"></script> |
| <script type="text/javascript" src="../assets/js/storm.js"></script> |
| </head> |
| |
| |
| <body> |
| <header> |
| <div class="container-fluid"> |
| <div class="row"> |
| <div class="col-md-5"> |
| <a href="../index.html"><img src="../images/logo.png" class="logo" alt="Logo"/></a> |
| </div> |
| <div class="col-md-5"> |
| |
| </div> |
| <div class="col-md-2"> |
| <a href="../downloads.html" class="btn-std btn-block btn-download">Download</a> |
| </div> |
| </div> |
| </div> |
| </header> |
| <!--Header End--> |
| <!--Navigation Begin--> |
| <div class="navbar" role="banner"> |
| <div class="container-fluid"> |
| <div class="navbar-header"> |
| <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-navbar-collapse"> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| </div> |
| <nav class="collapse navbar-collapse bs-navbar-collapse" role="navigation"> |
| <ul class="nav navbar-nav"> |
| <li><a href="../index.html" id="home">Home</a></li> |
| <li><a href="../getting-help.html" id="getting-help">Getting Help</a></li> |
| <li><a href="../about/integrates.html" id="project-info">Project Information</a></li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown" id="documentation">Documentation <b |
| class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="../releases/2.4.0/index.html">2.4.0</a></li> |
| <li><a href="../releases/2.3.0/index.html">2.3.0</a></li> |
| <li><a href="../releases/2.2.1/index.html">2.2.1</a></li> |
| <li><a href="../releases/2.2.0/index.html">2.2.0</a></li> |
| <li><a href="../releases/2.1.1/index.html">2.1.1</a></li> |
| <li><a href="../releases/2.1.0/index.html">2.1.0</a></li> |
| <li><a href="../releases/2.0.0/index.html">2.0.0</a></li> |
| <li><a href="../releases/1.2.4/index.html">1.2.4</a></li> |
| <li><a href="../releases/1.2.3/index.html">1.2.3</a></li> |
| </ul> |
| </li> |
| <li><a href="../talksAndVideos.html">Talks and Slideshows</a></li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown" id="contribute">Community <b |
| class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="../contribute/Contributing-to-Storm.html">Contributing</a></li> |
| <li><a href="../contribute/People.html">People</a></li> |
| <li><a href="../contribute/BYLAWS.html">ByLaws</a></li> |
| <li><a href="../Powered-By.html">PoweredBy</a></li> |
| </ul> |
| </li> |
| <li><a href="../2022/03/25/storm240-released.html" id="news">News</a></li> |
| </ul> |
| </nav> |
| </div> |
| </div> |
| |
| |
| <div class="container-fluid"> |
| <h1 class="page-title">Contributing</h1> |
| <div class="row"> |
| <div class="col-md-12"> |
| <!-- Documentation --> |
| |
| <p class="post-meta"></p> |
| |
| <div class="documentation-content"><h3 id="getting-started-with-contributing">Getting started with |
| contributing</h3> |
| |
| <p>Some of the issues on the <a href="https://issues.apache.org/jira/browse/STORM">issue tracker</a> are |
| marked with the "Newbie" label. If you're interesting in contributing to Storm but don't |
| know where to begin, these are good issues to start with. These issues are a great way to get your |
| feet wet with learning the codebase because they require learning about only an isolated portion of |
| the codebase and are a relatively small amount of work.</p> |
| |
| <h3 id="learning-the-codebase">Learning the codebase</h3> |
| |
| <p>The <a href="../documentation/Implementation-docs.html">Implementation docs</a> section of the wiki |
| gives detailed walkthroughs of the codebase. Reading through these docs is highly recommended to |
| understand the codebase.</p> |
| |
| <h3 id="contribution-process">Contribution process</h3> |
| |
| <p>Contributions to the Storm codebase should be sent as <a href="https://github.com/apache/storm">GitHub</a> |
| pull requests. If there's any problems to the pull request we can iterate on it using GitHub's |
| commenting features.</p> |
| |
| <p>For small patches, feel free to submit pull requests directly for them. For larger contributions, |
| please use the following process. The idea behind this process is to prevent any wasted work and |
| catch design issues early on:</p> |
| |
| <ol> |
| <li>Open an issue on the <a href="https://issues.apache.org/jira/browse/STORM">JIRA issue |
| tracker</a> if one doesn't exist already |
| </li> |
| <li>Comment on the issue with your plan for implementing the issue. Explain what pieces of the |
| codebase you're going to touch and how everything is going to fit together. |
| </li> |
| <li>Storm committers will iterate with you on the design to make sure you're on the right |
| track |
| </li> |
| <li>Read through the developer documentation on how to build, code style, testing, etc <a |
| href="https://github.com/apache/storm/blob/master/DEVELOPER.md">DEVELOPER.md</a></li> |
| <li>Implement your issue, submit a pull request prefixed with the JIRA ID (e.g. "STORM-123: add |
| new feature foo"), and iterate from there. |
| </li> |
| </ol> |
| |
| <h3 id="contributing-documentation">Contributing documentation</h3> |
| |
| <p>Documentation contributions are very welcome! The best way to send contributions is as emails through |
| the mailing list.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row"> |
| <div class="col-md-3"> |
| <div class="footer-widget"> |
| <h5>Meetups</h5> |
| <ul class="latest-news"> |
| |
| <li><a href="https://www.meetup.com/Apache-Storm-Apache-Kafka/">Apache Storm & Apache Kafka</a> |
| <span class="small">(Sunnyvale, CA)</span></li> |
| |
| <li><a href="https://www.meetup.com/Apache-Storm-Kafka-Users/">Apache Storm & Kafka Users</a> |
| <span class="small">(Seattle, WA)</span></li> |
| |
| <li><a href="https://www.meetup.com/New-York-City-Storm-User-Group/">NYC Storm User Group</a> |
| <span class="small">(New York, NY)</span></li> |
| |
| <li><a href="https://www.meetup.com/Bay-Area-Stream-Processing">Bay Area Stream Processing</a> |
| <span class="small">(Emeryville, CA)</span></li> |
| |
| <li><a href="https://www.meetup.com/Boston-Storm-Users/">Boston Realtime Data</a> <span |
| class="small">(Boston, MA)</span></li> |
| |
| <li><a href="https://www.meetup.com/storm-london">London Storm User Group</a> <span |
| class="small">(London, UK)</span></li> |
| |
| <!-- <li><a href="https://www.meetup.com/Apache-Storm-Kafka-Users/">Seatle, WA</a> <span class="small">(27 Jun 2015)</span></li> --> |
| </ul> |
| </div> |
| </div> |
| <div class="col-md-3"> |
| <div class="footer-widget"> |
| <h5>About Apache Storm</h5> |
| <p>Apache Storm integrates with any queueing system and any database system. Apache Storm's spout |
| abstraction makes it easy to integrate a new queuing system. Likewise, integrating Apache Storm |
| with database systems is easy.</p> |
| </div> |
| </div> |
| <div class="col-md-3"> |
| <div class="footer-widget"> |
| <h5>First Look</h5> |
| <ul class="footer-list"> |
| <li><a href="../releases/current/Rationale.html">Rationale</a></li> |
| <li><a href="../releases/current/Tutorial.html">Tutorial</a></li> |
| <li><a href="../releases/current/Setting-up-development-environment.html">Setting up development |
| environment</a></li> |
| <li><a href="../releases/current/Creating-a-new-Storm-project.html"> |
| Creating a new Apache Storm project</a></li> |
| </ul> |
| </div> |
| </div> |
| <div class="col-md-3"> |
| <div class="footer-widget"> |
| <h5>Documentation</h5> |
| <ul class="footer-list"> |
| <li><a href="../releases/current/index.html">Index</a></li> |
| <li><a href="../releases/current/javadocs/index.html">Javadoc</a></li> |
| <li><a href="../releases/current/FAQ.html">FAQ</a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <hr/> |
| <div class="row"> |
| <div class="col-md-12"> |
| <p align="center">Copyright © 2022 <a href="https://www.apache.org">Apache Software Foundation</a>. |
| All Rights Reserved. |
| <br>Apache Storm, Apache, the Apache feather logo, and the Apache Storm project logos are trademarks |
| of The Apache Software Foundation. |
| <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| </p> |
| </div> |
| </div> |
| </div> |
| </footer> |
| <!--Footer End--> |
| <!-- Scroll to top --> |
| <span class="totop"><a href="#"><i class="fa fa-angle-up"></i></a></span> |
| |
| </body> |
| |
| </html> |
| |