| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 1.8 from src/site/markdown/CONTRIBUTING.md at 2019-05-14 |
| | Rendered using Apache Maven Fluido Skin 1.7 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20190514" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Metron – How To Contribute</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script> |
| <script type="text/javascript"> |
| $( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } ); |
| </script> |
| </head> |
| <body class="topBarDisabled"> |
| <div class="container-fluid"> |
| <div id="banner"> |
| <div class="pull-left"><a href="http://metron.apache.org/" id="bannerLeft"><img src="images/metron-logo.png" alt="Apache Metron" width="148px" height="48px"/></a></div> |
| <div class="pull-right"></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li class=""><a href="http://www.apache.org" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> |
| <li class=""><a href="http://metron.apache.org/" class="externalLink" title="Metron">Metron</a><span class="divider">/</span></li> |
| <li class=""><a href="index.html" title="Documentation">Documentation</a><span class="divider">/</span></li> |
| <li class="active ">How To Contribute</li> |
| <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2019-05-14</li> |
| <li id="projectVersion" class="pull-right">Version: 0.7.1</li> |
| </ul> |
| </div> |
| <div class="row-fluid"> |
| <div id="leftColumn" class="span2"> |
| <div class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">User Documentation</li> |
| <li><a href="index.html" title="Metron"><span class="icon-chevron-down"></span>Metron</a> |
| <ul class="nav nav-list"> |
| <li class="active"><a href="#"><span class="none"></span>CONTRIBUTING</a></li> |
| <li><a href="Upgrading.html" title="Upgrading"><span class="none"></span>Upgrading</a></li> |
| <li><a href="metron-analytics/index.html" title="Analytics"><span class="icon-chevron-right"></span>Analytics</a></li> |
| <li><a href="metron-contrib/metron-docker/index.html" title="Docker"><span class="none"></span>Docker</a></li> |
| <li><a href="metron-contrib/metron-performance/index.html" title="Performance"><span class="none"></span>Performance</a></li> |
| <li><a href="metron-deployment/index.html" title="Deployment"><span class="icon-chevron-right"></span>Deployment</a></li> |
| <li><a href="metron-interface/index.html" title="Interface"><span class="icon-chevron-right"></span>Interface</a></li> |
| <li><a href="metron-platform/index.html" title="Platform"><span class="icon-chevron-right"></span>Platform</a></li> |
| <li><a href="metron-sensors/index.html" title="Sensors"><span class="icon-chevron-right"></span>Sensors</a></li> |
| <li><a href="metron-stellar/stellar-3rd-party-example/index.html" title="Stellar-3rd-party-example"><span class="none"></span>Stellar-3rd-party-example</a></li> |
| <li><a href="metron-stellar/stellar-common/index.html" title="Stellar-common"><span class="icon-chevron-right"></span>Stellar-common</a></li> |
| <li><a href="metron-stellar/stellar-zeppelin/index.html" title="Stellar-zeppelin"><span class="none"></span>Stellar-zeppelin</a></li> |
| <li><a href="use-cases/index.html" title="Use-cases"><span class="icon-chevron-right"></span>Use-cases</a></li> |
| </ul> |
| </li> |
| </ul> |
| <hr /> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> |
| </div> |
| </div> |
| </div> |
| <div id="bodyColumn" class="span10" > |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <h1>How To Contribute</h1> |
| <p><a name="How_To_Contribute"></a></p> |
| <p>As an open source project, Metron welcomes contributions of all forms. There are several great ways to contribute!</p> |
| <ul> |
| |
| <li><a href="#Contributing_a_Code_Change">Contributing a Code Change</a></li> |
| <li>Reviewing pull requests on our GitHub page. Check out current open <a class="externalLink" href="https://github.com/apache/metron/pulls">Pull Requests</a></li> |
| <li>Improve our documentation. Our docs are self contained in the project in README files. Doc changes are the same process as a code change. See <a href="#Contributing_a_Code_Change">Contributing a Code Change</a></li> |
| <li>Contributing to or starting discussions on the mailing lists. Both the user and dev lists are great places to give and receive help, or provide feedback. See <a class="externalLink" href="http://metron.apache.org/community/#mailinglist">Mailing Lists</a></li> |
| <li>Filing tickets for features, enhancements, and bugs to our JIRA. Take a look at <a class="externalLink" href="https://cwiki.apache.org/confluence/display/METRON/Reporting+Issues">Reporting Issues</a> and the <a class="externalLink" href="https://issues.apache.org/jira/projects/METRON">Metron JIRA</a></li> |
| </ul> |
| <div class="section"> |
| <h2><a name="Contributing_A_Code_Change"></a>Contributing A Code Change</h2> |
| <ol style="list-style-type: decimal"> |
| |
| <li>Open a <a class="externalLink" href="https://issues.apache.org/jira/projects/METRON">JIRA ticket</a> associated with your change, if one doesn’t already exist. Assign it to yourself and give a good description. |
| <ul> |
| |
| <li>Feel free to ask questions on the lists and collaborate!</li> |
| </ul> |
| </li> |
| <li>Implement your change |
| <ul> |
| |
| <li>We recommend setting up <a class="externalLink" href="https://docs.travis-ci.com">Travis CI</a> on your personal Github repo to handle long running testing. If the Travis build fails, you’ll want to look into it. See <a class="externalLink" href="https://docs.travis-ci.com/user/getting-started/#To-get-started-with-Travis-CI">Getting started</a> for instructions.</li> |
| </ul> |
| </li> |
| <li>Open a GitHub <a class="externalLink" href="https://github.com/apache/metron/pulls">Pull Request</a> with your change |
| <ul> |
| |
| <li>Fork the Metron repo. Look at <a class="externalLink" href="https://help.github.com/articles/fork-a-repo/">Fork a repo</a></li> |
| <li>Make the PR. See <a class="externalLink" href="https://help.github.com/articles/creating-a-pull-request-from-a-fork/">Creating a pull request from a fork</a></li> |
| <li>Make sure the PR name starts with your JIRA ticket number (METRON-XXXX).</li> |
| </ul> |
| </li> |
| <li>Iterate on your change with reviewers until it’s merged into master.</li> |
| </ol></div> |
| <div class="section"> |
| <h2><a name="Development_Guidelines"></a>Development Guidelines</h2> |
| <p>The full guidelines can be found on the <a class="externalLink" href="https://cwiki.apache.org/confluence/display/METRON/Development+Guidelines">Metron wiki</a>. They boil down to</p> |
| <ol style="list-style-type: decimal"> |
| |
| <li>Make sure you’ve tested your change.</li> |
| <li>Make sure you’ve documented your change.</li> |
| <li>Follow the <a class="externalLink" href="https://google.github.io/styleguide/javaguide.html">Google Java Style Guide</a> |
| <ul> |
| |
| <li>If the file is a different style follow that style.</li> |
| </ul> |
| </li> |
| <li>Be open to feedback.</li> |
| </ol></div> |
| </div> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| © 2015-2016 The Apache Software Foundation. Apache Metron, Metron, Apache, the Apache feather logo, |
| and the Apache Metron project logo are trademarks of The Apache Software Foundation. |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
