You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by bu...@apache.org on 2017/07/21 14:52:10 UTC
svn commit: r1015793 - in /websites/staging/maven/trunk/content: ./
guides/development/guide-committer-school.html images/mascot-student.png
images/mascot-student.svg maven-site-1.0-site.jar
Author: buildbot
Date: Fri Jul 21 14:52:10 2017
New Revision: 1015793
Log:
Staging update by buildbot for maven
Added:
websites/staging/maven/trunk/content/guides/development/guide-committer-school.html
websites/staging/maven/trunk/content/images/mascot-student.png (with props)
websites/staging/maven/trunk/content/images/mascot-student.svg (with props)
Modified:
websites/staging/maven/trunk/content/ (props changed)
websites/staging/maven/trunk/content/maven-site-1.0-site.jar
Propchange: websites/staging/maven/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Jul 21 14:52:10 2017
@@ -1 +1 @@
-1802560
+1802604
Added: websites/staging/maven/trunk/content/guides/development/guide-committer-school.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/development/guide-committer-school.html (added)
+++ websites/staging/maven/trunk/content/guides/development/guide-committer-school.html Fri Jul 21 14:52:10 2017
@@ -0,0 +1,207 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2017-07-21
+ | Rendered using Apache Maven Fluido Skin 1.6
+-->
+<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="author" content="Stephen Connolly
+Robert Scholte" />
+ <meta name="Date-Creation-yyyymmdd" content="20120711" />
+ <meta name="Date-Revision-yyyymmdd" content="20170721" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Maven – Do you want to become a Maven Committer?</title>
+ <link rel="stylesheet" href="../../css/apache-maven-fluido-1.6.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.6.min.js"></script>
+ <!-- Google Analytics -->
+ <script type="text/javascript">
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-140879-1']);
+ _gaq.push(['_trackPageview']);
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+ </script>
+ </head>
+ <body class="topBarDisabled">
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left"><a href="https://www.apache.org/" id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Apache Maven Site"/></a></div>
+ <div class="pull-right"><a href="../.././" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" /></a></div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+ <li class=""><a href="https://www.apache.org/" class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li>
+ <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li>
+ <li class="active ">Do you want to become a Maven Committer?</li>
+ <li id="publishDate" class="pull-right">Last Published: 2017-07-21</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">Main</li>
+ <li><a href="../../index.html" title="Welcome"><span class="none"></span>Welcome</a> </li>
+ <li><a href="https://www.apache.org/licenses/" class="externalLink" title="License"><span class="none"></span>License</a> </li>
+ <li><a href="../../download.html" title="Download"><span class="none"></span>Download</a> </li>
+ <li><a href="../../install.html" title="Install"><span class="none"></span>Install</a> </li>
+ <li><a href="../../configure.html" title="Configure"><span class="none"></span>Configure</a> </li>
+ <li><a href="../../run.html" title="Run"><span class="none"></span>Run</a> </li>
+ <li><a href="../../ide.html" title="IDE Integration"><span class="none"></span>IDE Integration</a> </li>
+ <li class="nav-header">About Maven</li>
+ <li><a href="../../what-is-maven.html" title="What is Maven?"><span class="none"></span>What is Maven?</a> </li>
+ <li><a href="../../maven-features.html" title="Features"><span class="none"></span>Features</a> </li>
+ <li><a href="../../general.html" title="FAQ"><span class="none"></span>FAQ</a> </li>
+ <li><a href="../../support-and-training.html" title="Support and Training"><span class="none"></span>Support and Training</a> </li>
+ <li class="nav-header">Documentation</li>
+ <li><a href="../../plugins/index.html" title="Maven Plugins"><span class="none"></span>Maven Plugins</a> </li>
+ <li><a href="../../guides/index.html" title="Index (category)"><span class="none"></span>Index (category)</a> </li>
+ <li><a href="../../run-maven/index.html" title="Running Maven"><span class="none"></span>Running Maven</a> </li>
+ <li><a href="../../users/index.html" title="User Centre"><span class="icon-chevron-right"></span>User Centre</a> </li>
+ <li><a href="../../plugin-developers/index.html" title="Plugin Developer Centre"><span class="icon-chevron-right"></span>Plugin Developer Centre</a> </li>
+ <li><a href="../../repository/index.html" title="Maven Central Repository"><span class="none"></span>Maven Central Repository</a> </li>
+ <li><a href="../../developers/index.html" title="Maven Developer Centre"><span class="none"></span>Maven Developer Centre</a> </li>
+ <li><a href="../../articles.html" title="Books and Resources"><span class="none"></span>Books and Resources</a> </li>
+ <li><a href="../../security.html" title="Security"><span class="none"></span>Security</a> </li>
+ <li class="nav-header">Community</li>
+ <li><a href="../../community.html" title="Community Overview"><span class="none"></span>Community Overview</a> </li>
+ <li><a href="../../guides/development/guide-helping.html" title="How to Contribute"><span class="none"></span>How to Contribute</a> </li>
+ <li><a href="../../guides/mini/guide-maven-evangelism.html" title="Maven Repository"><span class="none"></span>Maven Repository</a> </li>
+ <li><a href="../../users/getting-help.html" title="Getting Help"><span class="none"></span>Getting Help</a> </li>
+ <li><a href="../../issue-tracking.html" title="Issue Tracking"><span class="none"></span>Issue Tracking</a> </li>
+ <li><a href="../../source-repository.html" title="Source Repository"><span class="none"></span>Source Repository</a> </li>
+ <li><a href="../../team-list.html" title="The Maven Team"><span class="none"></span>The Maven Team</a> </li>
+ <li class="nav-header">Project Documentation</li>
+ <li><a href="../../project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a> </li>
+ <li class="nav-header">Maven Projects</li>
+ <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a> </li>
+ <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a> </li>
+ <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a> </li>
+ <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a> </li>
+ <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a> </li>
+ <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a> </li>
+ <li><a href="../../plugins/index.html" title="Plugins"><span class="none"></span>Plugins</a> </li>
+ <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a> </li>
+ <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a> </li>
+ <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a> </li>
+ <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a> </li>
+ <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a> </li>
+ <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a> </li>
+ <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a> </li>
+ <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a> </li>
+ <li class="nav-header">ASF</li>
+ <li><a href="https://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a> </li>
+ <li><a href="https://www.apache.org/foundation/" class="externalLink" title="Foundation"><span class="none"></span>Foundation</a> </li>
+ <li><a href="https://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a> </li>
+ <li><a href="https://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks"><span class="none"></span>Thanks</a> </li>
+ </ul>
+<form id="search-form" action="https://www.google.com/search" method="get" >
+ <input value="https://maven.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script>
+ <hr />
+ <div id="poweredBy">
+ <script type="text/javascript">asyncJs( 'https://apis.google.com/js/plusone.js' )</script>
+ <div class="g-plusone" data-href="https://maven.apache.org/" data-size="tall" ></div>
+ <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" >
+<div class="section">
+<h2><a name="Do_you_want_to_become_a_Maven_Committer"></a>Do you want to become a Maven Committer?</h2>
+<p>The Apache Software Foundation is a meritocracy. By this we mean that you gain status based on the merit of your work and actions. In fact the status that you gain is a recognition of the merit of your work and actions.</p>
+<p>Maven is an Apache project, that means that we have to follow the Apache rules and way. One of those rules is that we cannot hand out commit access to anyone who asks for it.</p>
+<p>To gain commit access you must establish your merit by submitting patches that get picked up by existing committers.</p>
+<p>After you have contributed enough patches to establish merit, the project management committee decides whether you can be trusted with commit access.</p>
+<p><i>The reality is that "It is what it is"TL;DR To become a Maven committer write good patches and get them applied.</i></p></div>
+<div class="section">
+<h2><a name="What_makes_a_good_patch"></a>What makes a good patch?</h2>
+<p>A good patch is a patch that applies cleanly and includes tests that cover both the positive and negative case and has documentation where relevant.</p>
+<p>For example, if you were implementing a patch to fix <a class="externalLink" href="http://issues.apache.org/jira/browse/MNG-4612">MNG-4612</a> you would first need to write a test case that is failing when trying to encrypt</p>
+<div>
+<pre>{DESede}y+qq...==</pre></div>
+<p>and a second test case that is passing when trying to encrypt</p>
+<div>
+<pre>password</pre></div>
+<p>This is in order to be sure that you have written an effective test case that can pass for good data. Then you implement the fix and all the tests should pass. You then take a Subversion compatible† diff of the source code and attach that to the issue in question.</p>
+<p>To understand how your patch gets evaluated, here is how I apply patches:</p>
+<ol style="list-style-type: decimal">
+<li>I look at the actual diff, if there is a whole lot of formatting changes irrelevant to the issue being fixed => <b>Patch is no good, ask on JIRA for a clean patch</b></li>
+<li>I look at the list of files in the diff, if there are no tests => <b>Patch is no good, ask on JIRA for test cases</b></li>
+<li>I look at the issue and if the issue requires documentation be updated and there is no documentation changes in the patch => <b>Patch is no good, ask on JIRA for documentation changes in the patch</b></li>
+<li>I take a clean checkout of the source that the patch applies to and try to apply the patch... if it does not apply clean => <b>Patch is no good, ask on JIRA for an updated patch</b></li>
+<li>I revert the src/main and run the tests. If the tests all pass, then there are no test cases to catch the bug => <b>Patch is no good, ask on JIRA for proper tests</b></li>
+<li>I revert src and run the tests. If any tests fail, then there is something wrong with the existing code => <b>If I have time I might try and fix the issue, otherwise I just move on</b></li>
+<li>I apply the patch a second time and run the tests. If the tests all pass => <b>Patch is good, I commit the patch and mark the JIRA as resolved</b></li></ol>
+<p>So there you have it, my guide to writing good patches... now the next step is getting your patches noticed...</p></div>
+<div class="section">
+<h2><a name="How_to_get_your_patches_noticed"></a>How to get your patches noticed</h2>
+<p>The simplest way to get your patches noticed is to submit them to the JIRA issue that they fix.</p>
+<p>Remember that the Maven project is run by volunteers in their spare time, so very often we may not notice your patch for a few days. </p>
+<p>If you are certain that your patch is a good patch, and a week has passed with no comments on JIRA, then you should send <i>one and only one</i> email to the <a class="externalLink" href="mailto:dev@maven.apache.org">dev@maven.apache.org</a> mailing list to see if your patch can get noticed.</p>
+<p><b>Note:</b> you need to be fairly confident that your patch is a good patch, because if you keep on pestering the Maven developers looking to have non-good patches applied, your merit will become negative and people will be less inclined to help you get your patches applied... also this is why you should send one and <i>only one</i> email about your patch on any specific JIRA issue.</p></div>
+<div class="section">
+<h2><a name="Stephen_Arnaud__Barries_school_for_potential_Maven_committers"></a>Stephen, Arnaud & Barrie's school for potential Maven committers</h2>
+<p>To help people who are interested in becoming Maven committers fulfill their goals, myself, Arnaud Heritier and Barrie Treloar (along with any other current Maven committers who decide to help) will be running an assignment based class to help people become committers. </p>
+<p>To register for the class you need to complete the following steps:</p>
+<ol style="list-style-type: decimal">
+<li>Read the <a class="externalLink" href="http://www.apache.org/licenses/icla.txt">Apache Individual Contributor License Agreement</a>. When you graduate from the class you will be required to sign this in order to become a committer.</li>
+<li>Subscribe to the <a class="externalLink" href="mailto:dev@maven.apache.org">dev@maven.apache.org</a> mailing list.</li>
+<li>Send an email to the list with the Subject line: <tt>[Committer School] I would like to become a committer</tt> and the Message body:
+<div>
+<pre>I am interested in the following areas:
+ _______, _______ and ______
+If anyone knows any issues that I could take a look at I would be very much appreciated
+
+Thanks</pre></div></li></ol>
+<p>Once you have registered your class assignments are basically to find JIRA issues that you want to fix. The issues can be in any part of Maven, but it is best to start with the areas you have the most interest in. Once you have found a JIRA issue that you are interested in fixing, the process will work a little something like this:</p>
+<ol style="list-style-type: decimal">
+<li>Make sure that nobody else is working on the issue and that the issue is one that should be fixed by sending an email to the list with a Subject line something like: <tt>[Committer School] Should I fix MNG-4612?</tt> The Message body should be something like:
+<div>
+<pre>I have had a look at MNG-4612 and I think this is a real issue because...
+
+I think I can fix it like so....
+
+Is that the correct way to go about fixing it and is it a real issue at all
+
+Thanks</pre></div></li>
+<li>Wait a couple of days. Arnaud, Barrie and I will do our best to respond quickly to all such emails, but please keep in mind that we are doing this in our spare time.</li>
+<li>If you get the all clear, develop your patch and upload it to the JIRA, after it is uploaded, send an email to the list with a subject line something like: <tt>[Committer School] Patch for review: MNG-4612</tt> The Message body should be something like:
+<div>
+<pre>I have tested that this is a good patch and I would appreciate if a committer could review and apply
+
+Thanks</pre></div></li></ol>
+<p>Keep in mind that the Committer School is just a way for us to identify people who are committed to developing patches with a view to eventually becoming committers. </p>
+<p>When we have enough evidence that we think we can get you accepted as a committer we will nominate you and hopefully your nomination will be accepted.</p>
+<p>Personally, if I see somebody averaging a good patch a week for 2-3 months and being active helping out on the <a class="externalLink" href="mailto:users@maven.apache.org">users@maven.apache.org</a> and <a class="externalLink" href="mailto:dev@maven.apache.org">dev@maven.apache.org</a> mailing lists then I think I could make a strong case for such a person being given commit access.</p>
+<p>So if you think you have the right stuff and want to become a Maven committer... class enrollment is open!</p></div>
+ </div>
+ </div>
+ </div>
+ <hr/>
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p>Copyright ©2002–2017
+<a href="https://www.apache.org/">The Apache Software Foundation</a>.
+All rights reserved.</p>
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
Added: websites/staging/maven/trunk/content/images/mascot-student.png
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maven/trunk/content/images/mascot-student.png
------------------------------------------------------------------------------
svn:mime-type = image/png
Added: websites/staging/maven/trunk/content/images/mascot-student.svg
==============================================================================
Binary file - no diff available.
Propchange: websites/staging/maven/trunk/content/images/mascot-student.svg
------------------------------------------------------------------------------
svn:mime-type = image/svg+xml
Modified: websites/staging/maven/trunk/content/maven-site-1.0-site.jar
==============================================================================
Binary files - no diff available.