Samza Enhancement Proposals
When making larger changes to Samza, or working on a project, please write a Samza Enhancement Proposal (SEP) on the Samza wiki. The goal of the SEP is to:
- Define the problem you’re trying to solve
- Propose a solution, and explore alternatives.
- Instigate discussion on the issue.
- Archive design documents for future use.
How to Write a SEP
SEPs are stored on the Samza wiki. To write a SEP, create a new sub page on the wiki with a title formatted as SEP-# (e.g. SEP-24).
There is no set single format for a SEP, but it’s common to include:
- Table of Contents
- Introduction
- Definition of problem
- Possible solutions
- Opinion on best solution
- Proposed metrics to add.
- A link to the JIRA.