| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <meta charset="utf-8"> |
| |
| |
| |
| <title>How to contribute to Apache Wicket | Apache Wicket</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <link rel="shortcut icon" href="/favicon.ico" type="image/vnd.microsoft.icon" /> |
| <link rel="stylesheet" href="/css/style.css" type="text/css" media="screen" /> |
| <link href="//maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" /> |
| |
| <script src="//code.jquery.com/jquery-1.11.3.min.js"></script> |
| |
| |
| </head> |
| <body class=""> |
| <div class="header default"> |
| <div class="l-container"> |
| |
| <nav class="mainmenu"> |
| <div class="nav-logo"> |
| <a href="/"><img src="/img/logo-apachewicket.svg" alt="Apache Wicket"></a> |
| </div> |
| |
| <div class="nav-container"> |
| |
| |
| |
| |
| |
| <!-- /start/quickstart.html || /contribute/ --> |
| |
| |
| |
| <a href="/start/quickstart.html" class=" nav-items">Quick Start</a> |
| |
| |
| |
| |
| |
| <!-- /start/download.html || /contribute/ --> |
| |
| |
| |
| <a href="/start/download.html" class=" nav-items">Download</a> |
| |
| |
| |
| |
| |
| <!-- /learn || /contribute/ --> |
| |
| |
| |
| <a href="/learn" class=" nav-items">Documentation</a> |
| |
| |
| |
| |
| |
| <!-- /help || /contribute/ --> |
| |
| |
| |
| <a href="/help" class=" nav-items">Support</a> |
| |
| |
| |
| |
| |
| <!-- /contribute || /contribute/ --> |
| |
| |
| |
| <a href="/contribute" class=" nav-items">Contribute</a> |
| |
| |
| |
| |
| |
| <!-- /community || /contribute/ --> |
| |
| |
| |
| <a href="/community" class=" nav-items">Community</a> |
| |
| |
| |
| |
| |
| <!-- /apache || /contribute/ --> |
| |
| |
| |
| <a href="/apache" class=" nav-items">Apache</a> |
| |
| </div> |
| <div class="nav-container "> |
| <a href="https://github.com/apache/wicket" target="_blank"><i class="fa fa-github nav-items"></i></a> |
| <a href="https://twitter.com/apache_wicket" target="_blank"><i class="fa fa-twitter nav-items"></i></a> |
| <a href="https://builtwithwicket.tumblr.com" target="_blank"><i class="fa fa-tumblr nav-items"></i></a> |
| </div> |
| </nav> |
| |
| </div> |
| </div> |
| <main> |
| <div class="l-container"> |
| <header class="l-full preamble"> |
| <h1>How to contribute to Apache Wicket</h1> |
| <h2>You can contribute to Apache Wicket in many ways, so join us and make Wicket better!</h2> |
| |
| |
| </header> |
| <section class="toc left default "> |
| <div id="toc" class="toc"><div id="toc-title"><h2>Table of Contents</h2></div><ul><li class="toc--level-1 toc--section-1"><a href="#contribute"><span class="toc-number">1</span> <span class="toc-text">Ways to Contribute to Apache Wicket</span></a></li><li class="toc--level-1 toc--section-2"><a href="#github"><span class="toc-number">2</span> <span class="toc-text">Github Mirror for Easy Contributing</span></a><ul><li class="toc--level-2 toc--section-3"><a href="#fork"><span class="toc-number">2.1</span> <span class="toc-text">Fork Wicket to your Account</span></a></li><li class="toc--level-2 toc--section-4"><a href="#clone"><span class="toc-number">2.2</span> <span class="toc-text">Clone Wicket to your Workstation</span></a></li><li class="toc--level-2 toc--section-5"><a href="#checkout"><span class="toc-number">2.3</span> <span class="toc-text">Start with the Correct Branch</span></a></li><li class="toc--level-2 toc--section-6"><a href="#pullrequest"><span class="toc-number">2.4</span> <span class="toc-text">Create a Pull Request</span></a></li></ul></li><li class="toc--level-1 toc--section-7"><a href="#documentation"><span class="toc-number">3</span> <span class="toc-text">Documentation for contributors</span></a><ul><li class="toc--level-2 toc--section-8"><a href="#how-to-contribute"><span class="toc-number">3.1</span> <span class="toc-text">How to contribute</span></a></li><li class="toc--level-2 toc--section-9"><a href="#committers"><span class="toc-number">3.2</span> <span class="toc-text">Committers</span></a></li><li class="toc--level-2 toc--section-10"><a href="#subscribing-and-unsubscribing"><span class="toc-number">3.3</span> <span class="toc-text">Subscribing and unsubscribing</span></a></li></ul></li></ul></div> |
| </section> |
| <section> |
| <h2 id="contribute">Ways to Contribute to Apache Wicket</h2> |
| |
| <p>A lot of work goes into maintaining a project like Wicket and we can |
| use your help!</p> |
| |
| <p>You can help us in many ways:</p> |
| |
| <ul> |
| <li>Help out other users at our <a href="../help/email.html">user list</a></li> |
| <li>Answer questions on <a href="http://stackoverflow.com/questions/tagged/wicket" rel="nofollow">Stackoverflow</a></li> |
| <li><a href="userguide.html">Improve our user guide</a></li> |
| <li>Report <a href="../help/#reportbug">your bugs</a></li> |
| <li>Implement <a href="patch.html">new features or fix bugs</a></li> |
| <li><a href="write.html">Improve this site</a></li> |
| </ul> |
| |
| <p>If you want to help out with one of our bugs or want to implement a |
| feature, consider using our <a href="#github">Github mirror</a>.</p> |
| |
| <hr /> |
| |
| <h2 id="github">Github Mirror for Easy Contributing</h2> |
| |
| <p>Wicket is mirrored on github so you can contribute with ease:</p> |
| |
| <ol> |
| <li>Fork Wicket</li> |
| <li>Implement your feature or fix the bug, and</li> |
| <li>Send a pull request.</li> |
| </ol> |
| |
| <p>The Github/Apache integration will send the pull request to our |
| contributors list, and we will look at your pull request as soon as we |
| can.</p> |
| |
| <h3 id="fork">Fork Wicket to your Account</h3> |
| |
| <p>So you have an account registered at Github and are ready to start |
| hacking at Wicket. First you need to <em>fork the code</em> to your own Github |
| account.</p> |
| |
| <p>You can find the official mirror for the Apache Wicket project at the |
| following location in the official Apache Software Foundation |
| organisation at Github:</p> |
| |
| <ul> |
| <li>Apache Wicket Github mirror: <a href="https://github.com/apache/wicket" rel="nofollow">https://github.com/apache/wicket</a></li> |
| </ul> |
| |
| <p>On this page you will find a button with the caption “Fork”. Click it |
| or use the button below.</p> |
| |
| <p><a class="button" rel="nofollow" href="https://github.com/apache/wicket/fork"> |
| <i class="fa fa-github"></i> Fork us on github |
| </a></p> |
| |
| <p>Now you have your own copy of Wicket to hack on. You can edit directly |
| in the Github web interface–good for minor fixes like documentation |
| errors–or clone the project to your workstation.</p> |
| |
| <h3 id="clone">Clone Wicket to your Workstation</h3> |
| |
| <p>You can use the tooling for Github to get a copy on your workstation or |
| use the commandline:</p> |
| |
| <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>git clone git@github.com:<your userid>/wicket.git</code></pre></figure> |
| |
| <p><strong>NB</strong> Ensure that you replace <em><your userid></em> with your actual |
| Github user id, otherwise your clone command will fail.</p> |
| |
| <p>This shell command will create a local checkout of the git repository. |
| Now you can check out the correct branch.</p> |
| |
| <h3 id="checkout">Start with the Correct Branch</h3> |
| |
| <p>Wicket is developed in several version branches. Depending on what you |
| want to work on you need to select the right one. The following table |
| shows the corresponding branch for each Wicket version.</p> |
| |
| <table> |
| <thead> |
| <tr> |
| <th>Wicket version</th> |
| <th>Branch name</th> |
| <th>Status</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>8.x</td> |
| <td>master</td> |
| <td>active</td> |
| </tr> |
| <tr> |
| <td>7.x</td> |
| <td>wicket-7.x</td> |
| <td>supported</td> |
| </tr> |
| <tr> |
| <td>6.x</td> |
| <td>wicket-6.x</td> |
| <td>security fixes only</td> |
| </tr> |
| <tr> |
| <td>1.5.x</td> |
| <td>wicket-1.5.x</td> |
| <td>discontinued</td> |
| </tr> |
| <tr> |
| <td><s>1.4.x</s></td> |
| <td><s>wicket-1.4.x</s></td> |
| <td><s>discontinued</s></td> |
| </tr> |
| <tr> |
| <td><s>1.3.x</s></td> |
| <td><s>wicket-1.3.x</s></td> |
| <td><s>discontinued</s></td> |
| </tr> |
| <tr> |
| <td><s>1.2.x</s></td> |
| <td><s>wicket-1.2.x</s></td> |
| <td><s>discontinued</s></td> |
| </tr> |
| <tr> |
| <td><s>1.1.x</s></td> |
| <td><s>wicket-1.1.x</s></td> |
| <td><s>discontinued</s></td> |
| </tr> |
| <tr> |
| <td><s>1.0.x</s></td> |
| <td><s>wicket-1.0.x</s></td> |
| <td><s>discontinued</s></td> |
| </tr> |
| </tbody> |
| </table> |
| |
| <p>If you want to work on Wicket 8, you need to check out the <em>master</em> branch.</p> |
| |
| <p>If you want to work on Wicket 7, you need to check out the <em>wicket-7.x</em> branch.</p> |
| |
| <p>When you are ready with your change you can ask us to review your |
| changes and to integrate it into Wicket by creating a Pull Request.</p> |
| |
| <h3 id="pullrequest">Create a Pull Request</h3> |
| |
| <p>Make sure you have pushed your changes to your Github repository. To |
| create a pull request on GitHub follow the instructions you can find <a href="https://help.github.com/articles/creating-a-pull-request/" rel="nofollow">here</a>. Once you have finished to work on you pull |
| request, send us an email using <a href="mailto:dev@wicket.apache.org">devs</a> |
| mailing list.</p> |
| |
| <p>The Github–Apache integration will automatically send a message to the |
| Wicket project that a new pull request is waiting for us.</p> |
| |
| <h2 id="documentation">Documentation for contributors</h2> |
| |
| <p>This section is particularly of interest for those who want to |
| contribute to Wicket.</p> |
| |
| <h3 id="how-to-contribute">How to contribute</h3> |
| |
| <p>Here’s a list of documents that explain how you can best help the Wicket team:</p> |
| |
| <ul> |
| <li><a href="/contribute/userguide.html">Write documentation</a> - Contribute to improve our user guide.</li> |
| <li><a href="/contribute/patch.html">Provide a patch or a pull request</a> - Think you have found a bug or just want to propose a new feature? Do it sending us a patch or creating a pull request on GitHub.</li> |
| <li><a href="/contribute/write.html">Contribute to the site</a> - Help us to improve our site.</li> |
| </ul> |
| |
| <h3 id="committers">Committers</h3> |
| |
| <p>Here’s a list of tasks that only committers can do:</p> |
| |
| <ul> |
| <li><a href="/contribute/release.html">Build a release</a></li> |
| </ul> |
| |
| <h3 id="subscribing-and-unsubscribing">Subscribing and unsubscribing</h3> |
| |
| <p><a href="mailto:dev@wicket.apache.org">Wicket development list</a> |
| Medium traffic |
| <a href="http://mail-archives.apache.org/mod_mbox/wicket-dev/">Archives</a> |
| <a href="http://wicket-dev.markmail.org/">Search</a> |
| <a href="mailto:dev-subscribe@wicket.apache.org?subject=Subscribe to Apache Wicket development list">Subscribe</a> |
| <a href="mailto:dev-unsubscribe@wicket.apache.org?subject=Unsubscribe from Apache Wicket development list">Unsubscribe</a> |
| <a href="mailto:dev-help@wicket.apache.org?subject=Help for Apache Wicket development list">Help</a></p> |
| |
| |
| |
| </section> |
| </div> |
| </main> |
| |
| <footer> |
| <div class="l-container"> |
| <div class="left"> |
| <img src="/img/asf_logo_url.svg" style="height:90px; float:left; margin-right:10px;"> |
| <div style="margin-top:12px;">Copyright © 2021 — The Apache Software Foundation. Apache Wicket, Wicket, Apache, the Apache feather logo, and the Apache Wicket project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div> |
| </div> |
| </div> |
| |
| </footer> |
| </body> |
| </html> |
