...
We are currently in the process of moving our contribution workflow to Github pull requests, so the patch review tool is slowly getting phased out. If you are still interested in using it, or learning more about it, you can find the instructions here.
Simple contributor workflow
This is the simple workflow and will work well for small features development for people who don't have direct access to check in to the Apache repository. Let's assume you are working on a feature or bug called, xyz:
1. Checkout a new repository:
Code Block |
---|
git clone https://git-wip-us.apache.org/repos/asf/kafka.git kafka
|
Or if you already have a copy of the repository, just check for updates
Code Block |
---|
git fetch
|
2. Create and checkout a feature branch to work in:
Code Block |
---|
git checkout -b xyz remotes/origin/trunk
|
3. Do some work on this branch and periodically checkin locally:
Code Block |
---|
git commit -a
|
4. When done (or periodically) rebase your branch to take any changes from trunk:
Code Block |
---|
git pull --rebase origin trunk
|
5. Make a patch containing your work and upload it to JIRA:
Code Block |
---|
git format-patch trunk --stdout > xyz-v1.patch
|
6. You may need to iterate/rebase your patch a few times as people comment on the code until a commit checks it in to the main repository.
You will also want to ensure you have your username and email setup correctly so that we correctly record the source of the contribution:
...
Contributor Workflow
The process for contributing a patch is documented in the Contributing Code Changes page.
Reviewer workflow:
This assumes you already have a copy of the repository.
...