Interested in contributing patches to Samza? This page will get you started.
Apache Samza is developed by an open and friendly community. Everybody is welcome to contribute and engage with the community. We are happy to accept contributions, be it trivial cleanups or bug-fix or new features. There are many ways to engage with the community and contribute to Apache Samza, including filing bugs, asking questions and joining discussions in our mailing lists, contributing code or documentation, or testing.
Apache Samza community is happy to answer any questions related to the project. We use our mailing list for all communications and discussions. You can also interact in StackOverflow under the tag - #apache-samza
File Bug Reports
Apache Samza uses JIRA to file bug reports. In order to file a bug report, please open Samza JIRA and include the following details:
- A descriptive title
- Description of the issue you are facing
- Version of Apache Samza in which this issue is seen - You can add the version(s) by updating “Affects Version/s” field in the JIRA
- Environment details (such as OS, JDK version etc) whenever applicable
If you need someone to immediately take a look at your JIRA, please don’t hesitate to send an email to the dev mailing list.
Find A Project to Work On
We tag bugs in JIRA with “newbie” label that are good for people getting started with the code base. When you feel confident, you can pick-up “newbie++” JIRAs. Picking up these JIRAs are the best way to familiarize yourself with the codebase.
More meaty projects are here. The process for working on a large project is:
- Instigate a discussion on the JIRA
- Write a design document
- Request feedback for the design document on the Jira and the samza-dev mailing list
- Come to an agreement on design
- Implement design
If you are unclear whether a change you are proposing requires a design document, feel free ask us through our mailing list!
Samza’s code is in an Apache Git repository located here.
You can check out Samza’s code by running:
git clone http://git-wip-us.apache.org/repos/asf/samza.git
Please read this page for coding style suggestions.
Please read this page for running various tests in Samza.
The Samza website is built by Jekyll from the markdown files found in the
Contribute using Pull Requests
We use Pull Requests to review and discuss your contributions. In order to contribute code, please do the following:
- If you are working on a big new feature, follow the steps outlined above regarding design documents page
- If there is no JIRA for your work, please open a JIRA before creating a Pull Request. If it is a trivial fix (such as typo, doc fix etc), you may skip the JIRA creation.
- Creating Pull Request
- Fork the Github repository at http://github.com/apache/samza if you haven’t already
- Create a new branch in your repository and push your changes to that branch
- Make sure you have observed the recommendations in the coding guide and testing
- Open a Pull Request against the “master” branch of apache/samza
- Make sure that the Pull Request title is of the format “SAMZA-<JiraNumber> : <JiraTitle>”
- Make sure that your patch cleanly applies against the master branch. If not, rebase before creating the Pull Request
- Change the status of the JIRA to “Patch Available” so that it notifies the committers of the patch being available
- Nag us if we don’t follow up on your JIRA in a timely fashion.
- If your Pull Request is approved, it will automatically be closed, with any associated JIRA when a committer merges your changes.
- If your Pull Request is not approved and requires changes based on reviews, please make changes to your patch.
- While making the changes, kindly update the JIRA status from “Patch Available” to “In Progress”.
- Make sure that you have rebased your branch to latest in the master branch before updating the Pull Request. This will help avoid conflicts during the merge. We cannot commit patches that have merge conflicts!
- If your Pull Request is rejected for whatever reason, please close it promptly because committers cannot close your Pull Requests!
Enabling merging through GitHub
- Apache ID (should have been set up in the initial committer onboarding process)
- You should be added as a committer to the Samza project (should have been set up in the initial committer onboarding process)
- Github account
- Join Apache Github organization
- Open https://id.apache.org/ and log into your Apache account.
- Fill in your GitHub username and save your change:
- An organization invitation email will be sent (usually in 30min, may up to few hours)
- Accept the invitation.
- An email confirming to add you as Samza committer will be sent (usually in 30min, may up to few hours) .
- Enable 2FA on Github
- This page (https://help.github.com/en/articles/configuring-two-factor-authentication) might be helpful for that.
- Link Apache and Github account
- Authorize Apache by clicking "Start ASF Oauth"
- Authorize GitHub Account
- Once your writer access is granted, you will see
- Congratulations! Now you have write access to Apache Samza Project!
Merging a pull request (PR)
- Make sure the PR can be cleanly merged (GitHub should report if it can be cleanly merged).
- At the bottom of the feed for the PR, there is a button with a selection dropdown for merging a branch. Make sure the "Squash and merge" option is selected, and then click "Squash and merge".
- Whenever possible, make sure that the commit title includes the JIRA number and title.
- The committer workflow used to involve running a "merge-pull-request.py" script. That flow is no longer applicable.
- For committers wishing to update the webpage, please see docs/README.md for instructions.