You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@karaf.apache.org by jb...@apache.org on 2017/07/04 12:14:31 UTC
svn commit: r1800765 - /karaf/site/production/community.html
Author: jbonofre
Date: Tue Jul 4 12:14:31 2017
New Revision: 1800765
URL: http://svn.apache.org/viewvc?rev=1800765&view=rev
Log:
[scm-publish] Updating main website contents
Modified:
karaf/site/production/community.html
Modified: karaf/site/production/community.html
URL: http://svn.apache.org/viewvc/karaf/site/production/community.html?rev=1800765&r1=1800764&r2=1800765&view=diff
==============================================================================
--- karaf/site/production/community.html (original)
+++ karaf/site/production/community.html Tue Jul 4 12:14:31 2017
@@ -75,6 +75,7 @@
<li><a href="https://builds.apache.org/view/H-L/view/Karaf/">Jenkins</a></li>
<li><a href="irc://irc.freenode.net/apache-karaf">#apache-karaf on Freenode</a></li>
</ul>
+
<h2 id="contribute">Contribute</h2>
There are many ways you can help make Karaf a better piece of software - please dive in and help!<br/>
<br/>
@@ -84,9 +85,107 @@
<br/>
<a href="https://github.com/apache/karaf">Browse the source code</a>. Got an itch to scratch, want to tune some operation or add some feature ?<br/>
<br/>
- Want to do some hacking on Karaf? Try surfing the our <a href="https://issues.apache.org/jira/browse/KARAF">issue tracker</a> for open issues or features that need to be implemented. Take ownership of an issue and try fix it.<br/>
- <br/>
If you'd rather have a more gentle introduction to working on the Karaf project, try looking at the test coverage report and help us get it even more green by supplying more test cases to get us closer to 100% coverage.
+
+ <h3 id="issue">Report bugs and feature requests</h3>
+
+ <p>Did you find a bug or want something implemented? Please report an issue in our <a href="https://issues.apache.org/jira/browse/KARAF">issue tracker</a>. When creating a bug make sure you document the steps to reproduce the issue and provide all necessary information like OS, versions your use, logs. When creating a feature request document your requirements first. Try to not directly describe the solution.<p>
+
+ <p>If you want to dive into development yourself then you can also browse for open issues or features that need to be implemented. Take ownership of an issue and try fix it. Before doing a bigger change describe the concept/design of what you plan to do. If unsure if the design is good or will be accepted discuss it on the dev list.</p>
+
+ <h3 id="pull-request">Provide changes in a pull request</h3>
+
+ The best way to provide changes is to fork karaf repo on github and provide a pull request with your changes. To make it easy to apply your changes please use the following conventions:
+ <ul class="community">
+ <li>Every pull request should have a matching jira issue</li>
+ <li>Do the change in a branch that is named like the jira issue id e.g KARAF-1234. To create this branch you can use:<br/>
+ <code>
+git clone http://github.com/apache/karaf<br/>
+git fetch --all<br/>
+git checkout -b my-branch origin/master<br/>
+ </code>
+ Don't forget to periodically rebase your branch:<br/>
+ <code>
+git pull --rebase<br/>
+git push GitHubUser my-branch --force<br/>
+ </code>
+ </li>
+ <li>Every commit in the branch should start with the jira issue id like this "[KARAF-123] More details"</li>
+ <li>You can squash your commits into one and force push your branch (not mandatory) using <code>git rebase -i apache/master</code></li>
+ <li>Test that your change works by adapting or adding tests.</li>
+ <li><a href="http://programmer.97things.oreilly.com/wiki/index.php/The_Boy_Scout_Rule">Follow the boy scout rule to "Always leave the campground cleaner than you found it."</a></li>
+ <li>Make sure you do a build before doing a PR. The build has to be successfull:<br/>
+ <code>
+mvn clean verify -Prelease -fae -T 1C
+ </code>
+ </li>
+ <li>If your PR has conflicts with the master then rebase the branch. PRs with conflicts are unlikely to be applied</li>
+ <li>Do not change too much in a PR. The smaller the PR the easier it is to apply and the faster it will be done</li>
+ <li>Sometimes PRs get lost. Do not hesitate to ask on the dev list if your PR seems to be ignored</li>
+ </ul>
+
+ <h3 id="review-pull-request">Review pull requests</h3>
+
+ Anyone can review pull requests but the merge can be done only by a committer.<br/>
+ If you want to review a PR then comment with <code>R:@yourgithubid</code>. This marks that you will do the review and also apply if you are a committer.<br/>
+ When reviewing check if the changes are done in a clean way and are tested with a unit and possibly integration test. Check that the build does not report more test failures than before. If you are not a committer then write a comment if you recommend a merge or not. Provide good instructions for the contributor how to improve his PR if it is not yet ok. Make sure you do a review timely. By commenting that you do a review you kind of block others from applying the change.<br/>
+ NB: Jenkins performs a build for each pull request. You can trigger a new build on a pull request using "retest this please" in a PR comment.
+
+ <h3 ir="apply-pull-request">Apply pull requests</h3>
+
+ This can obviously only be done by a committer. Do the following steps:
+
+ <ul class="community">
+ <li>
+ <li>As one time config, you can rename your git remote and add apache one:
+ <code>
+git remote add apache https://git-wip-us.apache.org/repos/asf/karaf.git<br/>
+ </code>
+ We recommand renaming <code>origin</code> as <code>github</code>:<br/>
+<code>
+git remote rename origin github<br/>
+</code>
+ For <code>github</code> remote, add an additional fetch reference, which will cause every pull request to be made available as a remote branch in your workspace.<br/>
+<code>
+git config --local --add remote.github.fetch '+refs/pull/*/head:refs/remotes/github/pr/*'
+</code>
+ You can confirm your configuration with the following command:
+<code>
+git remote -v<br/>
+apache https://git-wip-us.apache.org/repos/asf/karaf.git (fetch)<br/>
+apache https://git-wip-us.apache.org/repos/asf/karaf.git (push)<br/>
+github https://github.com/apache/karaf.git (fetch)<br/>
+github https://github.com/apache/karaf.git (push)<br/>
+username git@github.com:username/karaf.git (fetch)<br/>
+username git@github.com:username/karaf.git (push)<br/>
+</code>
+ </li>
+ <li>Checkout the PR:<br/>
+<code>
+git fetch --all
+git checkout -b pr-xxx github/pr/xxx
+</code>
+ </li>
+ <li>
+ Review the PR, amend, squash the commits, requesting changes, ... When done, add <code>LGTM</code> comment to approve the PR (or click on the "Approve" button on GitHub):<br/>
+<code>
+git rebase -i apache/master
+</code>
+ </li>
+ <li>
+ Merge the PR (it automatically closes the PR):<br/>
+<code>
+git fetch --all<br/>
+git checkout apache/master<br/>
+git merge --no-ff -m "[KARAF-nnnn] This closes #xxx" pr-xxx
+git push apache HEAD:master
+</code>
+ </li>
+ <li>Eventually backport commits to bugfix branches using <code>git cherry-pick</code></li>
+ <li>Make sure you document the fix in jira by adding the fix versions and resolve the jira issue</li>
+ <li>You can delete the PR branch: <code>git branch -D pr-xxx</code>.</li>
+ </ul>
+
<h2 id="support">Support</h2>
If you are experiencing problems using Karaf then please report your problem to our <a href="https://issues.apache.org/jira/browse/KARAF">issue tracker</a>.
You may also find it useful to discuss your issues with the community on the mailing lists or IRC.<br/>