Hello Shubhangi,
thanks for your interest in Kafka. In general, your proposal sounds very
good. We just need to be careful to not make things too complicated. If
we add more examples (and tests for examples), we also have more code to
maintain.
There is plenty of external resources about Kafka Streams, and there was
never a demand from the user community that we would need more examples.
So while in general a good idea, I am wondering how important it really is?
I am also asking, because we actually struggle to keep up reviewing PRs
for bug fixes and new features. Adding more examples seems to be lowest
in the priority list, and so nobody might have time (aka, make time) to
review PRs that add examples, as we might want to use our limited time
on bug-fix and feature PRs.
In the end, Kafka is of course an OSS project, so feel free to create
Jira tickets and/or open corresponding PRs. I just want to make sure
that you understand the overall capacity, and it might take time until
somebody will be able to review any of your PRs. -- So if you decide to
move forward with your idea, don't think there is no interest in your
work (in case your PRs don't get much attention), but it's rather a
problem is limited resources.
Thanks a lot,
-Matthias
On 7/26/25 6:48 PM, Pandey, Shubhangi wrote:
Dear Kafka Development Team,
I hope this email finds you well. I am a computer science student interested in
contributing to Apache Kafka, specifically to improve the Kafka Streams
examples and testing coverage. This is also a part of my course assignment CS
464 OSS at Oregon state university so I have a deadline to submit it in 2 days.
JIRA Account Request:
I have submitted a JIRA account request to contribute to the project but
understand it may take several days for approval. I'm reaching out to introduce
myself and outline my planned contributions to help expedite the process if
possible.
Proposed Contributions:
1. Missing Test Coverage for Streams Examples
Issue: The streams/examples/src/test/java/org/apache/kafka/streams/examples/
directory currently only contains tests for WordCount, while other examples
(pipe, pageview, etc.) lack corresponding test files.
Impact: This creates inconsistent testing coverage and makes it harder for new
users to understand proper testing patterns for Kafka Streams applications.
Proposed Solution: Add comprehensive test files for existing examples including
PipeDemo, PageViewTypedDemo, and others, following the existing WordCountTest
pattern.
2. Limited Kafka Streams Example Scenarios
Issue: Current examples don't cover many fundamental Kafka Streams patterns
that developers commonly need, such as stream-table joins, windowed
aggregations, or error handling.
Impact: Developers often struggle to find official examples for these common
use cases, leading to implementation inconsistencies.
Proposed Solution: Add new example files demonstrating:
Stream-table joins for data enrichment
Error handling and dead letter queue patterns
Multi-topic processing scenarios
Background:
I have thoroughly analyzed the current examples structure and identified these
gaps through studying the codebase and community discussions. Both
contributions would follow existing code conventions and include proper
documentation.
Questions:
Would the development team welcome these specific improvements?
Is there anything I should consider before proceeding with JIRA ticket creation?
I'm committed to following the project's contribution guidelines and would
appreciate any feedback or guidance from the community.
Thank you for your time and for maintaining such an excellent project.
Best regards,
Shubhangi
Note: I've also requested JIRA access and am awaiting approval to formally
submit these issues.
________________________________
From: Pandey, Shubhangi <pand...@oregonstate.edu.INVALID>
Sent: Saturday, July 26, 2025 6:34 PM
To: dev@kafka.apache.org <dev@kafka.apache.org>; dev-i...@kafka.apache.org
<dev-i...@kafka.apache.org>
Subject: Request for JIRA Access + Proposed Contributions to Kafka Streams
Examples
[You don't often get email from pand...@oregonstate.edu.invalid. Learn why this
is important at https://aka.ms/LearnAboutSenderIdentification ]
[This email originated from outside of OSU. Use caution with links and
attachments.]
Dear Kafka Development Team,
I hope this email finds you well. I am a computer science student interested in
contributing to Apache Kafka, specifically to improve the Kafka Streams
examples and testing coverage. This is also a part of my course assignment CS
464 OSS at Oregon state university so I have a deadline to submit it in 2 days.
JIRA Account Request:
I have submitted a JIRA account request to contribute to the project but
understand it may take several days for approval. I'm reaching out to introduce
myself and outline my planned contributions to help expedite the process if
possible.
Proposed Contributions:
1. Missing Test Coverage for Streams Examples
Issue: The streams/examples/src/test/java/org/apache/kafka/streams/examples/
directory currently only contains tests for WordCount, while other examples
(pipe, pageview, etc.) lack corresponding test files.
Impact: This creates inconsistent testing coverage and makes it harder for new
users to understand proper testing patterns for Kafka Streams applications.
Proposed Solution: Add comprehensive test files for existing examples including
PipeDemo, PageViewTypedDemo, and others, following the existing WordCountTest
pattern.
2. Limited Kafka Streams Example Scenarios
Issue: Current examples don't cover many fundamental Kafka Streams patterns
that developers commonly need, such as stream-table joins, windowed
aggregations, or error handling.
Impact: Developers often struggle to find official examples for these common
use cases, leading to implementation inconsistencies.
Proposed Solution: Add new example files demonstrating:
Stream-table joins for data enrichment
Error handling and dead letter queue patterns
Multi-topic processing scenarios
Background:
I have thoroughly analyzed the current examples structure and identified these
gaps through studying the codebase and community discussions. Both
contributions would follow existing code conventions and include proper
documentation.
Questions:
Would the development team welcome these specific improvements?
Is there anything I should consider before proceeding with JIRA ticket creation?
I'm committed to following the project's contribution guidelines and would
appreciate any feedback or guidance from the community.
Thank you for your time and for maintaining such an excellent project.
Best regards,
Shubhangi
Note: I've also requested JIRA access and am awaiting approval to formally
submit these issues.
