blob: 68e5287d94330e326ae57bdc680421908b1ffec0 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>ActiveMQ</title>
<link rel="icon" type="image/png" href="/assets/img/favicon.png">
<link rel="stylesheet" href="/css/main.css">
<script defer src="https://use.fontawesome.com/releases/v5.0.8/js/all.js" integrity="sha384-SlE991lGASHoBfWbelyBPLsUlwY1GwNDJo3jSJO04KZ33K2bwfV9YBauFfnzvynJ" crossorigin="anonymous"></script>
<script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js" integrity="sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q" crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/js/bootstrap.min.js" integrity="sha384-JZR6Spejh4U02d8jOt6vLEHfe/JQGiRRSQQxSfFWpi1MquVdAyjUar5+76PVCmYl" crossorigin="anonymous"></script>
</head>
<body>
<nav class="navbar navbar-expand-lg navbar-light fixed-top">
<div class="container">
<!-- <a class="navbar-brand mr-auto" href="#"><img style="height: 50px" src="assets/img/apache-feather.png" /></a> -->
<a class="navbar-brand mr-auto" href="/"><img src="/assets/img/activemq_logo_black_small.png" style="height: 50px"/></a>
<button class="navbar-toggler ml-auto" type="button" data-toggle="collapse" data-target="#navbarContent" aria-controls="navbarContent" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="ml-auto collapse navbar-collapse" id="navbarContent">
<ul class="navbar-nav ml-auto">
<li class="nav-item">
<a class="nav-link active" href="/index.html">Home</a>
</li>
<li class="nav-item dropdown">
<a class="nav-link" id="navbarDropdownComponents" data-target="#" href="" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Components</a>
<ul class="dropdown-menu dropdown-menu-center" aria-labelledby="navbarDropdownComponents">
<div class="row">
<div class="col-12">
<ul class="multi-column-dropdown">
<li class="nav-item"><a class="dropdown-item" href="/components/classic">ActiveMQ 5</a></li>
<li class="nav-item"><a class="dropdown-item" href="/components/artemis/">ActiveMQ Artemis</a></li>
<li class="nav-item"><a class="dropdown-item" href="/components/nms">NMS Clients</a></li>
<li class="nav-item"><a class="dropdown-item" href="/components/cms">CMS Client</a></li>
</ul>
</div>
</div>
</ul>
</li>
<li class="nav-item dropdown">
<a class="nav-link" id="navbarDropdownCommunity" data-target="#" href="" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Contact</a>
<ul class="dropdown-menu dropdown-menu-center multi-column columns-1" aria-labelledby="navbarDropdownCommunity">
<div class="row">
<div class="col-12">
<ul class="multi-column-dropdown">
<li class="nav-item"><a class="dropdown-item" href="/contact#mailing">Mailing Lists</a></li>
<li class="nav-item"><a class="dropdown-item" href="/contact#chat">Chat</a></li>
<li class="nav-item"><a class="dropdown-item" href="/contact#issues">Report Issues</a></li>
<li class="nav-item"><a class="dropdown-item" href="/contact#contributing">Contributing</a></li>
<li class="nav-item"><a class="dropdown-item" href="/security-advisories.html">Security</a></li>
</ul>
</div>
</div>
</ul>
</li>
<li class="nav-item dropdown">
<a class="nav-link" id="navbarDropdownTeam" data-target="#" href="" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Apache</a>
<ul class="dropdown-menu dropdown-menu-center multi-column columns-1" aria-labelledby="navbarDropdownTeam">
<div class="row">
<div class="col-sm-12">
<ul class="multi-column-dropdown">
<li class="nav-item"><a class="dropdown-item" href="https://www.apache.org">The Apache Software Foundation</a></li>
<li class="nav-item"><a class="dropdown-item" href="https://www.apache.org/licenses/">License</a></li>
<li class="nav-item"><a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
<li class="nav-item"><a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a></li>
<li class="nav-item"><a class="dropdown-item" href="/security-advisories.html">Security</a></li>
<li class="nav-item"><a class="dropdown-item" href="https://www.apache.org/events/current-event">Events</a></li>
<li class="nav-item"><a class="dropdown-item" href="https://people.apache.org/phonebook.html?pmc=activemq">PMC & Committers</a></li>
<li class="nav-item"><a class="dropdown-item" href="/team/reports">Board Reports</a></li>
</ul>
</div>
</div>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<div class="content">
<div class="page-title-activemq5">
<div class="container">
<h1>Contributing</h1>
</div>
</div>
<div class="container" >
<div class="row" style="margin-top: 30px">
<div class="col-12 activemq5">
<p><a href="community">Community</a> &gt; <a href="contributing">Contributing</a></p>
<p>There are many ways you can help make ActiveMQ a better piece of software - please dive in and help!</p>
<p>Try surf the documentation - if somethings confusing or not clear, let us know. Download the code &amp; try it out and see what you think. Browse the source code. Got an itch to scratch, want to tune some operation or add some feature?</p>
<p>Want to do some hacking on ActiveMQ? Try surfing to our <a href="http://issues.apache.org/jira/browse/AMQ">issue tracker</a> for open issues or features that need to be implemented, take ownership of an issue and try fix it.</p>
<h2 id="getting-in-touch">Getting in touch</h2>
<p>There are various ways of communicating with the ActiveMQ community.</p>
<ul>
<li>join us on the <a href="discussion-forums">Discussion Forums</a> or subscribe to the <a href="mailing-lists">Mailing Lists</a> and take part in any conversations</li>
<li>pop by on in <a href="irc">irc</a> and say hi</li>
<li>add some comments to the <a href="navigation">wiki</a></li>
</ul>
<h2 id="if-you-find-a-bug-or-problem">If you find a bug or problem</h2>
<p>Please raise a new issue in our <a href="https://issues.apache.org/jira/browse/AMQ">issue tracker</a></p>
<p>If you can create a JUnit test case then your issue is more likely to be resolved quicker.<br />
e.g. take a look at some of the existing <a href="https://git-wip-us.apache.org/repos/asf?p=activemq.git;a=tree;f=activemq-unit-tests/src/test;h=185a655c5200ed30fd2964bc236c18c5bde534c4;hb=refs/heads/master">unit tests cases</a></p>
<p>Then we can add your issue to the test suite and then we’ll know when its really fixed and we can ensure that the problem <strong>stays fixed</strong> in future releases.</p>
<h2 id="if-you-want-to-help-out-with-the-documentation">If you want to help out with the documentation</h2>
<p>If you want to contribute to the ActiveMQ documentation you should first subscribe our <a href="mailto:dev-subscribe@activemq.apache.org">dev@</a> where ActiveMQ developers interact with each other. If you want edit rights on the ActiveMQ site, create an account in the <a href="https://cwiki.apache.org/confluence/display/ACTIVEMQ">ActiveMQ wiki</a> and fill in and submit an ICLA to the ASF (see the <a href="Developers/becoming-a-committer.md">Committer Guide</a>). Then ask on the dev@ list to be granted edit rights and an admin will do so fairly quickly. If you want to just contribute the content, please submit the content on the dev@ list or create an issue and attach it there. <strong>All</strong> contributions are highly appreciated.</p>
<h2 id="working-on-the-code">Working on the code</h2>
<p>Grab the <a href="source">Source</a> from git</p>
<p>Build the project.</p>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>export MAVEN_OPTS="-Xmx512M -XX:MaxPermSize=128M"
mvn -Dtest=false install
</code></pre></div></div>
<p>PS: You might need to build multiple times (if you get a build error) because sometimes maven fails to download all the files.</p>
<p>Create a project in your IDE. e.g. if you are using Eclipse the following should do the trick.</p>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>mvn eclipse:eclipse
</code></pre></div></div>
<p>Then import the projects into your workspace.</p>
<h2 id="creating-patches">Creating patches</h2>
<p>We gladly accept patches if you can find ways to improve, tune or fix ActiveMQ in some way.</p>
<p>Most IDEs can create nice patches now very easily. e.g. in Eclipse just right click on a file/directory and select Team -&gt; Create Patch. Then just save the patch as a file and then submit it. (You may have to click on Team -&gt; Share… first to enable the Subversion options).</p>
<p>If you’re a command line person try the following to create the patch</p>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>diff -u Main.java.orig Main.java &gt;&gt; patchfile.txt
</code></pre></div></div>
<p>or</p>
<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>git diff Main.java &gt;&gt; patchfile.txt
</code></pre></div></div>
<h2 id="submitting-patches">Submitting patches</h2>
<p>The easiest way to submit a patch is to create a new JIRA issue, attach the patch and tick the ASF license grant check box, tick the Patch Attached button on the issue then fire off an email to the <a href="Community/mailing-lists.md">Mailing Lists</a> or <a href="CommunityCommunity/Community/discussion-forums.md">Discussion Forums</a>.</p>
<h2 id="becoming-a-commmitter">Becoming a commmitter</h2>
<p>Once you’ve got involved as above, we may well invite you to be a committer. See <a href="Developers/becoming-a-committer.md">Becoming a committer</a> for more details.</p>
<h2 id="using-the-issue-tracker">Using the issue tracker</h2>
<p>Before you can raise an issue in the issue tracker you need to register with it. This is quick &amp; painless.</p>
<p>If you want to have a go at fixing an issue you need to be in the list of activemq-developers on the issue tracker. To join the group, please mail the <a href="mailto:dev@activemq.apache.org">dev@activemq.apache.org</a> mail list with the email address you used to register with the issue tracker and we’ll add you to the group.</p>
<p>Why not dive in the <a href="https://issues.apache.org/jira/browse/AMQ">issue tracker</a>, and try tackle some of our outstanding issues?</p>
<h2 id="becoming-a-committer">Becoming a committer</h2>
<p>The first step is contributing to the project; if you want to take that a step forward and become a fellow committer on the project then see the <a href="Developers/becoming-a-committer.md">Committer Guide</a></p>
</div>
</div>
</div>
</div>
<div class="row sitemap">
<div class="col-sm-12">
<div class="container">
<div class="row">
<div class="col-sm-12">
<div class="row">
<div class="col-sm-3">
<div >
<img class="float-left" style="max-height: 100px" src="/assets/img/activemq_logo_white_vertical_small.png"/>
</div>
</div>
<div style="text-align: center; margin-bottom: 0px; margin-top: 30px; font-size: 65%" class="col-sm-6">
<p>Apache ActiveMQ, ActiveMQ, ActiveMQ Artemis, Apache, the Apache feather logo, and the Apache ActiveMQ project logo are trademarks of The Apache Software Foundation. Copyright &copy; 2019, The Apache Software Foundation. Licensed under <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License 2.0</a>.</p>
</div>
<div class="col-sm-3">
<div >
<a href="https://www.apache.org"><img class="float-right" style="margin-top: 10px; max-height: 80px" src="/assets/img/apache-logo-small.png"/></a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>