Page History

You need to register as a Trafodion contributor before you can help us develop Trafodion. Please perform the following registration actions:

Tools and Guidelines

Development Workflow

The following provides a basic overview of how we develop Trafodion.

Install Git Tools

Learn Trafodion

Starting out, we recommend the following approach:

1. Install the Git Tools:
   • Download the appropriate tool version; Linux or Windows: http://git-scm.com/downloads.
   • Set up your git environment: GitHub Documentation
     
     • Ensure that you register your ssh keys.

Download Trafodion Source Tree

You download the Trafodion source tree once the git tools have been installed.

1. Create Build Environment
2. Build the Trafodion Source Code
3. Create Test Environment
4. Run some of the tests in the Trafodion test libraries.
5. Use the Trafodion documentation to install Trafodion clients and play around with the different capabilities.
6. Learn how we manage defects.
7. Familiarize yourself with the Trafodion Development Workflow.

Once you've reached this point, then you

Fork Trafodion Repository

Clone Trafodion Repository

Use the git shell to perform this task.

# Move to the directory where you want to install the Trafodion source code.
cd mysource

# Clone the Trafodion source code
git clone git://git.apache.org/incubator-trafodion.git

# Register your fork as a remote branch
git remote add trafdeveloper_fork git@github.com:trafdeveloper/incubator-trafodion

At this point, you’ve finished all preparation steps. Now, you can start making changes.

Make Changes

Create Task Branch

You create a task branch to make changes to the Trafodion source tree . Typically, we name the branches after the Jira we are working on. In this example, the Jira is: TRAFODION-1507.

# Ensure that you have the latest changes
git fetch --all

# Checkout source
git checkout -b TRAFODION-1507 origin/master

Change Recipes

How to make changes depends on what part of the source tree you are working on. Please refer to the following chapters:

Commit Changes 

Perform the following steps to commit your changes. 

# Commit changes
git commit -a

# Dry-run check against main branch
git push -n trafdeveloper_fork HEAD

# Push changes to your private fork
git push trafdeveloper_fork TRAFODION-1507

Create Pull Request

Your changes need to be reviewed by a Trafodion committer. Therefore, you need to create a pull request for your private repository.

The Trafodion Automated Tests are triggered to run on every pull request. These tests take several hours to run. We always run these tests even if you’ve changed documentation or the web site to ensure that no inadvertent change to the rest of the source tree occurred as part of your changes. Please refer to Automated Tests for information about how to check the outcome of these tests.

Using GitHub Web Site (Preferred)

Do the following: 

1.  Go to https://github.com/apache/incubator-trafodion. 
2. Click the green Create Pull Request button. 
3. Review changes one more time before clicking Create Pull Request.

Using Git Bash 

Do the following:

# Generate pull request
git pull-request

Ensure that you include the Jira ID at the beginning of the title in your pull request. For example: [TRAFODION-1507] Explanation of the changes you made.

Review Comments

The pull request gets reviewed by the committers and once you get a consensus, then the committer merges your changes into the main incubator-trafodion branch. Check your e-mail for comments.

Address Review Comments

 If you need to make additional changes, then do the following (the example below uses a sample Jira ID):

depending on interest area:

• Modify Code
• Modify Tests
• Modify Documentation
• Modify Web Site
• Modify Wiki

We're glad your interested in helping us grow Trafodion. If you have any question, send an e-mail to dev@trafodion.incubator.apache.org.

Next Steps

You should have a basic understanding of how Trafodion is developed at this point. Where you go next depends on what areas you intend to contribute to:

• Create Build Environment: Trafodion requires a number of Linux packages and tools before you can build the code. This step is required if you intend to work on the Trafodion source or test code. It’s not strictly needed if you intend to work on the Trafodion documentation or web site; you can build these components without the complete Trafodion Build Environment. Refer to Modify Documentation or Modify Web Site.

• Build Source: You can build the Trafodion source once the Build Environment has been created. Several options are available, including the capability to build the Trafodion binaries.

  Note
  You MUST create the Build Environment before Building the Source.

• Create Test Environment: You need to set up the Trafodion test environment in order to run the different Trafodion test libraries. You need to set up an Hadoop environment to test Trafodion. Trafodion includes scripts to create a small Hadoop environment, if needed.

  Note
  You MUST create the Build Environment before creating the Test Environment.

This step is not necessary if you just want to build a Trafodion binary or if you working on the Documentation and/or Web Site.