You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2016/05/21 07:20:03 UTC
svn commit: r988804 - in /websites/production/camel/content:
cache/main.pageCache contributing.html
Author: buildbot
Date: Sat May 21 07:20:03 2016
New Revision: 988804
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/contributing.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/contributing.html
==============================================================================
--- websites/production/camel/content/contributing.html (original)
+++ websites/production/camel/content/contributing.html Sat May 21 07:20:03 2016
@@ -84,23 +84,25 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><p>There are many ways you can help make Camel 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 & 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 Camel? Try surfing the our <a shape="rect" class="external-link" href="http://issues.apache.org/activemq/browse/CAMEL">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 are a new Camel rider and would like to help us, you can also find some <a shape="rect" class="external-link" href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?mode=hide&requestId=12316782">easy to resolve issues</a>. Leave a comment on the issue to let us know you are working on it and add yourself as a watcher t
o get informed about all modifications.</p><h2 id="Contributing-Gettingintouch">Getting in touch</h2><p>There are various ways of communicating with the Camel community.</p><ul class="alternate"><li>join us on the <a shape="rect" href="discussion-forums.html">Discussion Forums</a> and take part in any conversations</li><li>pop by on <a shape="rect" href="irc-room.html">IRC</a> and say hi</li><li>add some comments to the <a shape="rect" href="navigation.html">wiki</a></li></ul><h2 id="Contributing-Improvingthedocumentation">Improving the documentation</h2><p>Documentation is massively important to help users make the most of Apache Camel and its probably the area that needs the most help!</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!</p><p>Most of the documentation is stored on the wiki. We are currently
moving the documentation into the code (<a shape="rect" href="asciidoc.html">AsciiDoc</a>). From there it is automatically converted to the wiki. So before editing the wiki check the code because otherwise your changes may be lost. This transition is work-in-progress.</p><p>See <a shape="rect" href="how-does-the-website-work.html">How does the website work</a> or <a shape="rect" href="how-do-i-edit-the-website.html">How do I edit the website</a> for more details.</p><p>To be able to edit the wiki you need</p><ol><li>an appropriate licence agreement on file with the ASF</li><li>an account on the wiki (on the bottom of each page there is an edit button, that allows you to create an account)</li><li>karma - mail the <a shape="rect" href="mailing-lists.html">dev list</a> asking for permission (to prevent spam we only offer access to the wiki by folks sending mail to the mailing list).</li></ol><h2 id="Contributing-Ifyoufindabugorproblem">If you find a bug or problem</h2><p>Please
raise a new issue in our <a shape="rect" class="external-link" href="http://issues.apache.org/activemq/browse/CAMEL">issue tracker</a></p><p>If you can create a JUnit test case then your issue is more likely to be resolved quicker.<br clear="none"> e.g. take a look at some of the existing <a shape="rect" class="external-link" href="https://svn.apache.org/repos/asf/camel/trunk/camel-core/src/test/java/">unit tests cases</a></p><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 id="Contributing-Workingonthecode">Working on the code</h2><p>Grab the <a shape="rect" href="source.html">Source</a> and create a project in your IDE. e.g. if you are using Eclipse the following should do the trick...</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="wiki-content maincontent"><p>There are many ways you can help make Camel 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 & 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 Camel? Try surfing the our <a shape="rect" class="external-link" href="http://issues.apache.org/activemq/browse/CAMEL">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 are a new Camel rider and would like to help us, you can also find some <a shape="rect" class="external-link" href="https://issues.apache.org/jira/secure/IssueNavigator.jspa?mode=hide&requestId=12316782">easy to resolve issues</a>. Leave a comment on the issue to let us know you are working on it and add yourself as a watcher t
o get informed about all modifications.</p><h2 id="Contributing-Gettingintouch">Getting in touch</h2><p>There are various ways of communicating with the Camel community.</p><ul class="alternate"><li>join us on the <a shape="rect" href="discussion-forums.html">Discussion Forums</a> and take part in any conversations</li><li>pop by on <a shape="rect" href="irc-room.html">IRC</a> and say hi</li><li>add some comments to the <a shape="rect" href="navigation.html">wiki</a></li></ul><h2 id="Contributing-Improvingthedocumentation">Improving the documentation</h2><p>Documentation is massively important to help users make the most of Apache Camel and its probably the area that needs the most help!</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!</p><p>Most of the documentation is stored on the wiki. We are currently
moving the documentation into the code (<a shape="rect" href="asciidoc.html">AsciiDoc</a>). From there it is automatically converted to the wiki. So before editing the wiki check the code because otherwise your changes may be lost. This transition is work-in-progress.</p><p>See <a shape="rect" href="how-does-the-website-work.html">How does the website work</a> or <a shape="rect" href="how-do-i-edit-the-website.html">How do I edit the website</a> for more details.</p><p>To be able to edit the wiki you need</p><ol><li>an appropriate licence agreement on file with the ASF</li><li>an account on the wiki (on the bottom of each page there is an edit button, that allows you to create an account)</li><li>karma - mail the <a shape="rect" href="mailing-lists.html">dev list</a> asking for permission (to prevent spam we only offer access to the wiki by folks sending mail to the mailing list).</li></ol><h2 id="Contributing-Ifyoufindabugorproblem">If you find a bug or problem</h2><p>Please
raise a new issue in our <a shape="rect" class="external-link" href="http://issues.apache.org/activemq/browse/CAMEL">issue tracker</a></p><p>If you can create a JUnit test case then your issue is more likely to be resolved quicker.<br clear="none"> e.g. take a look at some of the existing <a shape="rect" class="external-link" href="https://svn.apache.org/repos/asf/camel/trunk/camel-core/src/test/java/">unit tests cases</a></p><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 id="Contributing-Workingonthecode">Working on the code</h2><p>We recommend to work on the code from <a shape="rect" class="external-link" href="https://github.com/apache/camel/" rel="nofollow">github</a>. </p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[git clone https://github.com/apache/camel.git
+cd camel]]></script>
+</div></div><p>Build the project (without testing).</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[mvn clean install -Dtest=false]]></script>
+</div></div><p>If you intend to work on the code and provide patches and other work you want to submit to the Apache Camel project, then you can fork the project on github and work on your own fork. The custom work you do should be done on branches you create, which can then be committed and pushed upstream, and then submitted to Apache Camel as PRs (pull requests). You can find many resources online how to work on github projects and how to submit work to these projects.</p><h4 id="Contributing-ApacheCamelcommittersshouldworkontheASFgitrepo">Apache Camel committers should work on the ASF git repo</h4><p>If you are an Apache Camel committer then clone the ASF git repo at</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[git clone https://git-wip-us.apache.org/repos/asf/camel.git
cd camel
-mvn eclipse:eclipse
]]></script>
</div></div><p>Build the project (without testing).</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[mvn clean install -Dtest=false
]]></script>
-</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>Then import the projects into your workspace.</p><h2 id="Contributing-Creatingpatches">Creating patches</h2><div class="confluence-information-macro confluence-information-macro-information"><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>When providing code patches then please include the Camel JIRA ticket number in the commit messages. We favor using the syntax:</p><p>CAMEL-9999: Some message goes here</p></div></div><p> </p><p>We gladly accept patches if you can find ways to improve, tune or fix Camel 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 -> Create Patch. Then just save the patch as a file and then submit it. (You may have to clic
k on Team -> 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="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</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>Then import the projects into your workspace.</p><h2 id="Contributing-Creatingpatches">Creating patches</h2><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>We recommend you create patches as github PRs which is much easier for us to accept and work with. You do this as any other github project, where you can fork the project, and create a branch where you work on the code, and then commit and push that code to your fork. Then navigate to the Apache Camel github webpage, and you will see that github in the top of the page has a wizard to send your recent work as a PR (pull request).</p></div></div><h4 id="Contributing-PullrequestatGithub">Pull request at Github</h4
><p>There is also a Git <a shape="rect" class="external-link" href="https://github.com/apache/camel" rel="nofollow">repository at Github</a> which you could fork. Then you submit patches as any other github project - eg work on a new feature branch and send a pull request. One of the committers then needs to accept your pull request to bring the code  to the ASF codebase. After the code has been included into the ASF codebase, you need to close the pull request because we can't do that...</p><p> </p><div class="confluence-information-macro confluence-information-macro-information"><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>When providing code patches then please include the Camel JIRA ticket number in the commit messages. We favor using the syntax:</p><p>CAMEL-9999: Some message goes here</p></div></div><p> </p><h4 id="Contributing-Manualpatchfiles">Manual
patch files</h4><p>We gladly accept patches if you can find ways to improve, tune or fix Camel in some way.</p><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>We recommend using github PRs instead of manual patch files. Especially for bigger patches.</p></div></div><p>Most IDEs can create nice patches now very easily. e.g. in Eclipse just right click on a file/directory and select Team -> Create Patch. Then just save the patch as a file and then submit it. (You may have to click on Team -> 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="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[diff -u Main.java.orig Main.java >> patchfile.txt
]]></script>
</div></div><p>or</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[git diff --no-prefix > patchfile.txt
]]></script>
-</div></div><h2 id="Contributing-Submittingpatches">Submitting patches</h2><p>The easiest way to submit a patch is to</p><ul><li><a shape="rect" class="external-link" href="https://issues.apache.org/jira/browse/CAMEL">create a new JIRA issue</a> (you will need to register),</li><li>attach the patch or tarball as an attachment</li><li><strong>tick the Patch Attached</strong> button on the issue</li></ul><p>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!</p><h2 id="Contributing-WorkingwithGit">Working with Git</h2><p>There are several ways how Git users could improve Camel with their prefered tool:</p><ul><li>Apache Git Mirror</li><li>Pull request at Github</li></ul><h3 id="Contributing-ApacheGitMirror">Apache Git Mirror</h3><p>Cloning the Apache git repo.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[git clone https://git-wip-us.apache.org/repos/asf/camel.git]]></script>
-</div></div><p>Bringing your modifications back to Apache is the <a shape="rect" class="external-link" href="https://git-wip-us.apache.org/docs/workflow.html">same workflow as described before</a>.</p><h3 id="Contributing-PullrequestatGithub">Pull request at Github</h3><p>There is also a Git <a shape="rect" class="external-link" href="https://github.com/apache/camel" rel="nofollow">repository at Github</a> which you could fork. Then you submit patches as any other github project - eg work on a new feature branch and send a pull request. One of the committers then needs to accept your pull request to bring the code  to the ASF codebase. After the code has been included into the ASF codebase, you need to close the pull request because we can't do that...</p><h3 id="Contributing-Moreresources">More resources</h3><p>Git is not a brand new technology and therefore Camel is not the only ASF project thinking about using it. So here are some more resources you mind find useful:</p><ul>
<li><a shape="rect" class="external-link" href="http://wiki.apache.org/general/GitAtApache">http://wiki.apache.org/general/GitAtApache</a>: Some basic notes about git@asf</li><li><a shape="rect" class="external-link" href="http://git.apache.org/">http://git.apache.org/</a>: List of mgit-mirrors at ASF</li><li><a shape="rect" class="external-link" href="https://git-wip-us.apache.org/">https://git-wip-us.apache.org/</a>: More Git infos from Apache</li></ul><h2 id="Contributing-Becomingacommitter">Becoming a committer</h2><p>Once you've got involved as above, we may well invite you to be a committer. See <a shape="rect" href="how-do-i-become-a-committer.html">How do I become a committer</a> for more details.</p><h2 id="Contributing-Usingtheissuetracker">Using the issue tracker</h2><p>Before you can raise an issue in the <a shape="rect" class="external-link" href="http://issues.apache.org/activemq/browse/CAMEL">issue tracker</a> you need to register with it. This is quick & painless
.</p><p>If you want to have a go at fixing an issue you need to be in the list of camel-developers on the issue tracker. To join the group, please mail the <code>dev@camel.apache.org</code> mail list with the email address you used to register with the issue tracker and we'll add you to the group.</p><h2 id="Contributing-Becomingacommitter.1">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 shape="rect" class="external-link" href="http://activemq.apache.org/becoming-a-committer.html">Committer Guide</a></p></div>
+</div></div><h2 id="Contributing-Submittingpatches">Submitting patches</h2><p>The easiest way to submit a patch is to</p><ul><li><a shape="rect" class="external-link" href="https://issues.apache.org/jira/browse/CAMEL">create a new JIRA issue</a> (you will need to register),</li><li>attach the patch or tarball as an attachment (if you create a patch file, but we recommend using github PRs)</li><li><strong>tick the Patch Attached</strong> button on the issue</li></ul><p>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!</p><h3 id="Contributing-Moreresources">More resources</h3><p>Git is not a brand new technology and therefore Camel is not the only ASF project thinking about using it. So here are some more resources you mind find useful:</p><ul><li><a shape="rect" class="external-link" href="http://wiki.apache.org/general/GitAtApache">http://wiki.apache.org/gene
ral/GitAtApache</a>: Some basic notes about git@asf</li><li><a shape="rect" class="external-link" href="http://git.apache.org/">http://git.apache.org/</a>: List of mgit-mirrors at ASF</li><li><a shape="rect" class="external-link" href="https://git-wip-us.apache.org/">https://git-wip-us.apache.org/</a>: More Git infos from Apache</li></ul><h2 id="Contributing-Becomingacommitter">Becoming a committer</h2><p>Once you've got involved as above, we may well invite you to be a committer. See <a shape="rect" href="how-do-i-become-a-committer.html">How do I become a committer</a> for more details.</p><h2 id="Contributing-Usingtheissuetracker">Using the issue tracker</h2><p>Before you can raise an issue in the <a shape="rect" class="external-link" href="http://issues.apache.org/activemq/browse/CAMEL">issue tracker</a> you need to register with it. This is quick & painless.</p><p>If you want to have a go at fixing an issue you need to be in the list of camel-developers on the issue tracker
. To join the group, please mail the <code>dev@camel.apache.org</code> mail list with the email address you used to register with the issue tracker and we'll add you to the group.</p><h2 id="Contributing-Becomingacommitter.1">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 shape="rect" class="external-link" href="http://activemq.apache.org/becoming-a-committer.html">Committer Guide</a></p></div>
</td>
<td valign="top">
<div class="navigation">