karaf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Karaf > Contributing
Date Thu, 01 Jul 2010 13:12:00 GMT
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/1810/9/3/_/styles/combined.css?spaceKey=KARAF&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/KARAF/Contributing">Contributing</a></h2>
    <h4>Page <b>edited</b> by             <a href="https://cwiki.apache.org/confluence/display/~gnodet">Guillaume
                         <h4>Changes (2)</h4>
<div id="page-diffs">
            <table class="diff" cellpadding="0" cellspacing="0">
            <tr><td class="diff-snipped" >...<br></td></tr>
            <tr><td class="diff-unchanged" >If you want to have a go at fixing
an issue you need to be in the list of karaf-developers on the issue tracker. To join the
group, please mail the dev@karaf.apache.org mail list with the email address you used to register
with the issue tracker and we&#39;ll add you to the group. <br> <br></td></tr>
            <tr><td class="diff-changed-lines" >Why not dive in and try tackle
some of our <span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">outstanding
issues?</span> <span class="diff-added-words"style="background-color: #dfd;">[outstanding
            <tr><td class="diff-deleted-lines" style="color:#999;background-color:#fdd;text-decoration:line-through;">{jiraissues:url=https://issues.apache.org/jira/sr/jira.issueviews:searchrequest-xml/temp/SearchRequest.xml?pid=12311140&amp;resolution=-1&amp;sorter/field=updated&amp;sorter/order=DESC&amp;tempMax=1000|anonymous=true|cache=off}
</div>                            <h4>Full Content</h4>
                    <div class="notificationGreySide">
        <p>There are many ways you can help make Karaf a better piece of software -
please dive in and help&#33;</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 Karaf? Try surfing the our <a href="http://issues.apache.org/jira/browse/KARAF"
class="external-link" rel="nofollow">issue tracker</a> for open issues or features
that need to be implemented, take ownership of an issue and try fix it.</p>

<p>If you'd rather a more gentle introduction to working on the Karaf project, how about
you try look at the<br/>
<a href="http://nemo.sonar.codehaus.org/project/index/XXXX" class="external-link" rel="nofollow">test
coverage report</a> and help us get it even more green by supplying more test cases
to get us closer to 100% coverage.</p>

<h2><a name="Contributing-Gettingintouch"></a>Getting in touch</h2>

<p>There are various ways of communicating with the Karaf community.</p>
<ul class="alternate" type="square">
	<li>join us on the <a href="/confluence/display/KARAF/Discussion+Forums" title="Discussion
Forums">Discussion Forums</a> and take part in any conversations</li>
	<li>pop by on <a href="irc://irc.codehaus.org/karaf" class="external-link" rel="nofollow">IRC</a>
and say hi</li>
	<li>add some comments to the <a href="/confluence/display/KARAF/Navigation" title="Navigation">wiki</a></li>

<h2><a name="Contributing-Improvingthedocumentation"></a>Improving the documentation</h2>

<p>Documentation is massively important to help users make the most of Apache Karaf
and its probably the area that needs the most help&#33;</p>

<p>So if you are interested in helping the documentation effort; whether its just to
fix a page here or there, correct a link or even write a tutorial or improve what documentation
is already there please do dive in and help&#33;</p>

<p>All of the documentation is stored on the wiki. See <a href="/confluence/display/KARAF/How+does+the+website+work"
title="How does the website work">How does the website work</a> or <a href="/confluence/display/KARAF/How+do+I+edit+the+website"
title="How do I edit the website">How do I edit the website</a> for more details.</p>

<p>To be able to edit the wiki you need to mail the <a href="/confluence/display/KARAF/Mailing+Lists"
title="Mailing Lists">dev list</a> asking for an account (to prevent spam we only
offer access to the wiki by folks sending mail to the mailing list).</p>

<h2><a name="Contributing-Ifyoufindabugorproblem"></a>If you find a bug
or problem</h2>

<p>Please raise a new issue in our <a href="http://issues.apache.org/jira/browse/KARAF"
class="external-link" rel="nofollow">issue tracker</a></p>

<p>If you can create a JUnit test case then your issue is more likely to be resolved

<p>Then we can add your issue to Subversion and then we'll know when its really fixed
and we can ensure that the problem stays fixed in future releases.</p>

<h2><a name="Contributing-Workingonthecode"></a>Working on the code</h2>

<p>Grab the <a href="/confluence/display/KARAF/Source" title="Source">Source</a>
and create a project in your IDE. e.g. if you are using Eclipse the following should do the
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
svn co https:<span class="code-comment">//svn.apache.org/repos/asf/karaf/trunk karaf
</span>cd karaf
mvn eclipse:eclipse
<p>Build the project.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
mvn install
<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>Then import the projects into your workspace.</p>

<h2><a name="Contributing-Creatingpatches"></a>Creating patches</h2>

<p>We gladly accept patches if you can find ways to improve, tune or fix Karaf in some

<p>Most IDEs can create nice patches now very easily. e.g. in Eclipse just right click
on a file/directory and select Team &#45;&gt; Create Patch. Then just save the patch
as a file and then submit it. (You may have to click on Team &#45;&gt; Share... first
to enable the Subversion options). Incidentally if you are an Eclipse user you should install
the <a href="http://subclipse.tigris.org/" class="external-link" rel="nofollow">subclipse</a>

<p>If you're a command line person try the following to create the patch</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
diff -u Main.java.orig Main.java &gt;&gt; patchfile.txt
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
svn diff Main.java &gt;&gt; patchfile.txt

<h2><a name="Contributing-Submittingpatches"></a>Submitting patches</h2>

<p>The easiest way to submit a patch is to</p>
	<li><a href="http://issues.apache.org/jira/browse/KARAF" class="external-link" rel="nofollow">create
a new JIRA issue</a> (you will need to register),</li>
	<li>attach the patch or tarball as an attachment</li>
	<li><b>tick the Patch Attached</b> button on the issue</li>
	<li>fire off an email to the <a href="/confluence/display/KARAF/Discussion+Forums"
title="Discussion Forums">Discussion Forums</a> linking to the JIRA</li>

<p>When a ticket is create in JIRA it automatically sends an email to the developer
forum but an email always helps alert folks (as lots of emails are generated from every change
to every JIRA).</p>

<p>Remember to create and attach the patch in two steps, as JIRA does not support granting
ASF license to the patch in the create ticket wizard. So after creating the ticket, then attach
the patch and remember to tick off the grant ASF license, otherwise we can not commit the
patch. We prefer patches has unit tests as well and that these unit tests have proper assertions
as well, so remember to replace your system.out or logging with an assertion instead&#33;</p>

<h2><a name="Contributing-Becomingacommitter"></a>Becoming a committer</h2>

<p>Once you've got involved as above, we may well invite you to be a committer. See
<a href="/confluence/display/KARAF/How+do+I+become+a+committer" title="How do I become
a committer">How do I become a committer</a> for more details.</p>

<h2><a name="Contributing-Usingtheissuetracker"></a>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 karaf-developers
on the issue tracker. To join the group, please mail the dev@karaf.apache.org 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 and try tackle some of our <a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;mode=hide&amp;pid=12311140&amp;resolution=-1&amp;sorter/field=updated&amp;sorter/order=DESC"
class="external-link" rel="nofollow">outstanding issues</a>?</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/KARAF/Contributing">View
        <a href="https://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=22872262&revisedVersion=6&originalVersion=5">View
        <a href="https://cwiki.apache.org/confluence/display/KARAF/Contributing?showComments=true&amp;showCommentArea=true#addcomment">Add

View raw message