Versions Compared

Old Version 17

changes.mady.by.user Ismael Juma Juma

Saved on

compared with

New Version 18

changes.mady.by.user Ismael Juma Juma

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Tweak description around transient test failures.

...

  1. Fork the Github repository at http://github.com/apache/kafka if you haven't already

  2. Clone your fork, create a new branch, push commits to the branch (review the Kafka Coding Guidelines, if you haven't already).

  3. Consider whether documentation or tests need to be added or updated as part of the change, and add them as needed.

  4. Run all tests as described in the project's README.

  5. Open a pull request against the trunk branch of apache/kafka. (Only in special cases would the PR be opened against other branches.)

    1. The PR title should usually be of the form KAFKA-xxxx; Title, where KAFKA-xxxx is the relevant JIRA id and Title may be the JIRA's title or a more specific title describing the PR itself. For trivial cases where a JIRA is not required (see JIRA section for more details) MINOR; or HOTFIX; can be used as the PR title prefix.

    2. If the pull request is still a work in progress, and so is not ready to be merged, but needs to be pushed to Github to facilitate review, then add [WIP] after the JIRA id.

    3. Consider identifying committers or other contributors who have worked on the code being changed. Find the file(s) in Github and click "Blame" to see a line-by-line annotation of who changed the code last and check the Maintainers page. You can add @username in the PR description to ping them immediately.

    4. Please state that the contribution is your original work and that you license the work to the project under the project's open source license.

  6. A comment with information about the pull request will be added to the JIRA ticket.

  7. Change the status of the JIRA to "Patch Available" if it's ready for review.

  8. The Jenkins automatic pull request builder will test your changes.

  9. Once ready, the test results will be posted on the pull request, along with a link to the full results on Jenkins.

  10. Watch for the results, and investigate and fix failures promptlyInvestigate and fix failures caused by the pull the request

    1. Fixes can simply be pushed to the same branch from which you opened your pull request.

    2. Jenkins will automatically re-test when new commits are pushed, if an existing commit is amended or if the branch is rebased.

    3. Despite our efforts, Kafka may have flaky tests at any given point, which may cause a build to fail. Unfortunately, it's not currently possible to restart the build by issuing a command , which can be an issue due to flaky tests. We (we are talking to Apache Infra about this issue). If the failure is unrelated to your pull request and you have been able to run the tests successfully locally, please mention it in the pull request.

The Review Process

  • Other reviewers, including committers, may comment on the changes and suggest modifications. Changes can be added by simply pushing more commits to the same branch.

  • Patches can be applied locally following the comments on the JIRA ticket, for example: git pull https://github.com/[contribuer-name]/kafka KAFKA-xxxx.

  • Lively, polite, rapid technical debate is encouraged from everyone in the community. The outcome may be a rejection of the entire change.

  • Reviewers can indicate that a change looks suitable for merging with a comment such as: "I think this patch looks good". Kafka uses the LGTM convention for indicating the strongest level of technical sign-off on a patch: simply comment with the word "LGTM". It specifically means: "I've looked at this thoroughly and take as much ownership as if I wrote the patch myself". If you comment LGTM you will be expected to help with bugs or follow-up issues on the patch. Consistent, judicious use of LGTMs is a great way to gain credibility as a reviewer with the broader community.

  • The JIRA ticket status will changed from "Patch Available" to "In Progress" if the pull request needs more work.

  • Sometimes, other changes will be merged which conflict with your pull request's changes. The PR can't be merged until the conflict is resolved. This can be resolved with "git fetch origin" followed by "git rebase origin/trunk" and resolving the conflicts by hand, then pushing the result to your branch.

  • Try to be responsive to the discussion rather than let days pass between replies

...