Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

If you'd like to report a bug in Tez or ask for a new feature, open an issue on the Apache Tez JIRA. For general usage help, you should email the user mailing list. For developers contributing to Tez and are looking for help, you should an email to the dev mailing list.

How to Contribute

Getting Started

Ready to Contribute?

  • Look for Newbie JIRAs to work on
  • Add a comment to the JIRA that you wish to work on and ask for it to be assigned to you
  • Take a look at the sections below for the basics of submitting patches.
  • Feel free to send questions to the Dev Mailing List if you have any questions
  • If you do not get a response on a JIRA within a couple of days, please send a polite reminder/ask for help on the dev mailing list.

Setting up your dev environment

...

  • If you are new to Tez and want to start with pre-existing issues, look for Jiras labeled  JIRAs labelled newbie.
    •  Once, you have found an unassigned issue to work on, add a comment stating your interest to work on the issue and one of the committers will assign the issue to you.
  • When making changes, follow the same coding style as the code that you are modifying.
    • Please ensure that each line remains with a 100-char limit.  
  • Ensure that all newly added code is documented well with javadocs as appropriate.
  • Add unit tests for your code.

Submitting a Patch

  • Once you have made the required changes, ensure that the code compiles and all the unit tests run successfully. 
  • Now, you can generate a patch using "git diff --no-prefix origin/master"  ( Use "origin/branchname" to generate a diff against a different branch.
  • Name the patch file using the JIRA issue and a patch version or a datetime when the patch was generated. For example, "TEZ-1234.1.patch" or "TEZ-1234.20140516.1.patch"
    • Add the branch name to patch filename in case the patch is generated for a branch other than master.
  • Attach this patch file to the JIRA issue and hit "Submit Patch" to change the issue status to "Patch Available". This will trigger a utility that will test the patch by applying it, checking for various issues ( new warnings, findbugs, new tests added, etc) and also run unit tests after applying the patch.
  • If you do not see any feedback on your patch within a couple of days, please send a friendly reminder mail to the dev mailing list.  









...