Child pages
  • Contributor's Corner
Skip to end of metadata
Go to start of metadata

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.

Ask Questions

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:

  1. Instigate a discussion on the JIRA
  2. Write a design document
  3. Request feedback for the design document on the Jira and the samza-dev mailing list
  4. Come to an agreement on design
  5. Implement design

If you are unclear whether a change you are proposing requires a design document, feel free ask us through our mailing list!

Contributor Workflow  

Setup

Samza’s code is in an Apache Git repository located here.

You can check out Samza’s code by running:


Style

Please read this page for coding style suggestions.

Tests

Please read this page for running various tests in Samza.

Website

The Samza website is built by Jekyll from the markdown files found in the docs subdirectory.

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
    1. Fork the Github repository at http://github.com/apache/samza if you haven’t already
    2. Create a new branch in your repository and push your changes to that branch
    3. 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
    4. 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!

Committer Workflow

If you are a committer you need to use https instead of http to check in, otherwise you will get an error regarding an inability to acquire a lock. Note that older versions of git may also give this error even when the repo was cloned with https; if you experience this try a newer version of git.

Prepare to merge a Pull Request (PR) by setting up the following:

  1. Setup JIRA on your host
    • Install Jira packages - sudo pip install jira
    • Set the JIRA_USERNAME and JIRA_PASSWORD environment variables with the appropriate credentials for interacting with Jira. This is required to correctly close the JIRA associated with the PR
  2. Setup aliases for the remote repositories:(Samza Github repo and Apache Samza Repo)
    • Add ASF git repo for committing the PR 

    • Add Github repo for fetching the patch from the PR 
  3. Set up API tokens for Git
    • Create an OAuth key for making requests to the GitHub API. If this is not defined, then requests will be unauthenticated and you can’t access the API. An OAuth key for the API can be created at https://github.com/settings/tokens
    • Set the created OAuth key as GITHUB_OAUTH_KEY environment variable.

Merging a Pull Request

  • Committers can use the bin/merge-pull-request.py script to merge an approved PR. The script is interactive and will walk you through the steps for merging the patch, closing the PR and the associated JIRA. cd samza ./bin/merge-pull-request.py
  • Whenever possible, make sure that the commit title includes the JIRA number and title.
  • Merging changes that don’t cleanly apply on the master should be avoided.
  • For committers wishing to update the webpage, please see docs/README.md for instructions.

 

Write a comment…