THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
| Tip |
|---|
| When you contribute code, you affirm that the contribution is your original work and that you license the work to the project under the project's open source license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's open source license and warrant that you have the legal authority to do so. |
Overview
| Table of Contents |
|---|
...
Overview
Generally, Kafka uses:
- JIRA to to track logical issues, including bugs and improvements
- Confluence for documentation and Kafka Improvement Proposals for planning major changes
- Confluence for documentation
- Github pull requests to to manage the review and merge of specific code changes
That is, JIRA and Confluence are used to describe what should be fixed or changed, and high-level approaches, and pull requests describe how to implement that change in the project's source code.
JIRA
Find the existing Kafka JIRA that the change pertains to.
Do not create a new JIRA if creating a change to address an existing issue in JIRA; add to the existing discussion and work instead
Look for existing pull requests that are linked from the JIRA, to understand if someone is already working on the JIRA
If the change is new, then it usually needs a new JIRA. However, trivial changes, where "what should change" is virtually the same as "how it should change" do not require a JIRA. Example: "Fix typos in Foo scaladoc"
If required, create a new JIRA:
Provide a descriptive Title. "Update web UI" or "Problem in scheduler" is not sufficient. "Kafka support fails to handle empty queue during shutdown" is good.
Write a detailed Description. For bug reports, this should ideally include a short reproduction of the problem. For new features, it may include a design document (or a Kafka Improvement Proposal if it's a major change).
Set required fields.
Do not include a patch file; pull requests are used to propose the actual change.
If the change is a large change, consider inviting discussion on the issue at dev@kafka.apache.org first before proceeding to implement the change.
...