This page describes the mechanics of how to contribute codes to Tajo.
Here are some things you will need to build and test Tajo. It does take some time to set up a working Tajo development environment, so be prepared to invest some time. Before you actually begin trying to code in it, try getting the project to build and test locally first. This is how you can test your installation.
Tajo uses GIT for its SCM system. There are some excellent GUIs for this, and IDEs with tight GIT integration, but as all our examples are from the command line, it is convenient to have the command line tools installed and a basic understanding of them.
You are free to use whatever IDE you prefer, or your favorite command line editor. Note that
To build the code, install
These should also be on your PATH; test by executing mvn and javac respectively.
As the Tajo builds use the external Maven repository to download artifacts, Maven needs to be set up with the proxy settings needed to make external HTTP requests. You will also need to be online for the first builds of Tajo project, so that the dependencies can all be downloaded.
The Tajo build requires ProtocolBuffers 2.5.0. You must install ProtocolBuffer according to the package manager of your OS. You can check as follows if ProtocolBuffer is available:
$ protoc --version libprotoc 2.5.0
First of all, you need the Tajo source code. The official location for Tajo is the Apache Git repository. Most development is done on the master branch. You can get the source of the master branch as the following command:
git clone https://git-wip-us.apache.org/repos/asf/tajo.git tajo
If you want to develop against a specific branch or release, visit [[https://git-wip-us.apache.org/repos/asf/tajo.git]] and find the branch that you are interested in developing against. To copy this branch, run
git clone -b [BRANCH NAME] https://git-wip-us.apache.org/repos/asf/tajo.git tajo
Before you start, send a message to the Tajo developer mailing list (email@example.com), or file a bug report in Tajo Jira. Describe your proposed changes and check that they fit in with what others are doing and have planned for the project. Be patient, it may take folks a while to understand your requirements. Modify the source code and add some (very) nice features using your favorite IDE.
But take care about the following points
Please make sure that all unit tests succeed before constructing your patch and that no new javac compiler warnings are introduced by your patch. For building Tajo with Maven, use the following to run all unit tests and build a distribution.
mvn clean install -Pdist -Dtar
If you use your favorite IDE to run unit tests, you firstly check if the unit tests use MiniTajoYarnCluster or TpchTestBase. If so, you must give the JVM option '-Dtajo.test=TRUE' to your IDE's run configuration. This option forces TaskRunnerLauncherImpl to automatically set CLASSPATH and environment variables used to launch containers on Yarn cluster. If this JVM option is not set, TaskRunnerLaunchImpl depends on the environment variables of the shell.
Check to see what files you have modified with:
Add any new files with:
git add src/../MyNewClass.java git add src/../TestMyNewClass.java
in order to create a patch, type:
git diff --no-prefix > TAJO-7777.patch
or if you have worked on your local branch, type:
git diff master --no-prefix > TAJO-7777.patch
These will report all modifications done on Tajo sources on your local disk and save them into the TAJO-7777.patch file. Read the patch file. Make sure it includes ONLY the modifications required to fix a single issue.
Please do not:
A suggested patch naming scheme is below:
Another alternative for patch naming is shown below:
To apply a patch either you generated or found from JIRA, you can issue
patch -p0 < cool_patch.patch
Please comment on issues in Jira, making their concerns known. Please also vote for issues that are a high priority for you. Please refrain from editing descriptions and comments if possible, as edits spam the mailing list and clutter Jira's "All" display, which is otherwise very useful. Instead, preview descriptions and comments using the preview button (on the right) before posting them. Keep descriptions brief and save more elaborate proposals for comments, since descriptions are included in Jira's automatically sent messages. If you change your mind, note this in a new comment, rather than editing an older comment. The issue should preserve this history of the discussion.
Contributors should join themailing lists. In particular, the commit list (to see changes as they are made) and the dev list (to join discussions of changes and help users).