...
Fork the Github repository at http://github.com/apache/kafka if you haven't already
Clone your fork, create a new branch, push commits to the branch (review the Kafka Coding Guidelines, if you haven't already).
Consider whether documentation or tests need to be added or updated as part of the change, and add them as needed.
Run all tests as described in the project's README.
Open a pull request against the trunk branch of apache/kafka. (Only in special cases would the PR be opened against other branches.)
The PR title should be of the form
[KAFKA-xxxx]
Title, whereKAFKA-xxxx
is the relevant JIRA id andTitle
may be the JIRA's title or a more specific title describing the PR itself.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.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.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.
The related JIRA, if any, will be marked as "In Progress" and your A comment with information about the pull request will automatically be linked added to itthe JIRA ticket.
- Change the status of the JIRA status to "Patch Available" if it's ready for review.
...