felix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Felix > Contributing Source Code
Date Fri, 01 Oct 2010 16:50:00 GMT
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/1810/9/1/_/styles/combined.css?spaceKey=FELIX&amp;forWysiwyg=true"
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/FELIX/Contributing+Source+Code">Contributing
Source Code</a></h2>
    <h4>Page  <b>added</b> by             <a href="https://cwiki.apache.org/confluence/display/~heavy@ungoverned.org">Richard
S. Hall</a>
    <div class="notificationGreySide">
         <h1><a name="ContributingSourceCode-SourceCodeContributions"></a>Source
Code Contributions</h1>

<p>Source code contributions fall into two categories: patches or grants. This document
describes both and how to handle each.</p>

<h2><a name="ContributingSourceCode-Patches"></a>Patches</h2>

<p>A patch is a small change to an existing code, typically in response to a bug fix
or improvement. If you have created a patch, you should:</p>

	<li>Create a <a href="http://issues.apache.org/jira/browse/Felix" class="external-link"
rel="nofollow">JIRA</a> issue (or find a pertinent existing issue) describing the
issue needing to be addressed.</li>
	<li>Attach the patch (in the form of a diff) to the above issue and describe how the
patch addresses the issue.</li>
	<li>If you intend to have your patch used by us, make sure you <b>grant Apache
the rights to use it</b> when you attach the patch to the issue.</li>
	<li>The patch will eventually be reviewed and applied (if accepted) by a Felix committer,
but feel free to bug us <a href="/confluence/pages/createpage.action?spaceKey=FELIX&amp;title=nicely&amp;linkCreation=true&amp;fromPageId=23339504"
class="createlink">nicely</a> if you get impatient.</li>

<p>Providing patches is a very good way to become a committer at Felix, since we'd rather
have you review and apply the patches then us. <img class="emoticon" src="/confluence/images/icons/emoticons/smile.gif"
height="20" width="20" align="absmiddle" alt="" border="0"/></p>

<h2><a name="ContributingSourceCode-Grants"></a>Grants</h2>

<p>A grant involves donating a larger chunk of code developed elsewhere. The line dividing
a patch and a grant is sort of like the definition of pornography, we know it when we see
it. The steps for granting software are a little more complicated since we need to ensure
proper IP handling. For grants, you should:</p>

	<li>Verify that you have the authorization to donate the code.</li>
	<li>Review our developer documentation as well as the general Apache documentation
to determine whether you would really like be involved with us and how we work.</li>
	<li>Create a <a href="http://issues.apache.org/jira/browse/Felix" class="external-link"
rel="nofollow">JIRA</a> issue describing the code you wish to donate.</li>
	<li>Attach an archive containing the code along with an MD5 signature of the archive
to the above issue. You should remove any existing headers from the source files and add the
standard Apache header to each. Note that you keep the rights to your code and can do anything
with it you want, you will just grant us the right to use it too.</li>
	<li>Allow the community time to discuss the contribution, after which a vote will be
called to accept the contribution.</li>
	<li>If the vote passes, then you will need to submit a <a href="http://www.apache.org/licenses/software-grant.txt"
class="external-link" rel="nofollow">software grant</a> form.</li>
	<li>It is also a good idea to submit an <a href="http://www.apache.org/licenses/icla.txt"
class="external-link" rel="nofollow">ICLA</a> to ease future contributions. Depending
on the company you work for, they may also want to contribute a <a href="http://www.apache.org/licenses/cla-corporate.txt"
class="external-link" rel="nofollow">CCLA</a>, although this isn't strictly necessary
from an Apache point of view, since it is your responsibility to verify your ability to submit
an ICLA.</li>
	<li>Once all of this information is received, then we will gather it and perform <a
href="http://incubator.apache.org/ip-clearance/index.html" class="external-link" rel="nofollow">IP
	<li>After a few days, if no red flags are raised, then we'll commit the code and we're
good to go.</li>

<p>Granting code is also a path to committership at Felix, since we look more highly
on contributions from developers who wish to stay involved in the continuing evolution and
maintenance of the donated code.</p>
    <div id="commentsSection" class="wiki-content pageSection">
       <div style="float: right;">
            <a href="https://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
       <a href="https://cwiki.apache.org/confluence/display/FELIX/Contributing+Source+Code">View
       <a href="https://cwiki.apache.org/confluence/display/FELIX/Contributing+Source+Code?showComments=true&amp;showCommentArea=true#addcomment">Add

View raw message