Versions Compared

Key

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

...

Excerpt

Documents a basic overview of how we develop Trafodion.

Anchor
getting-started-development-workflow
getting-started-development-workflow

Working in Git

Install Git Tools

You use git to make changes to the Trafodion code, tests, documentation, and web site:

Info
titleGit Cheat Sheet

For future reference, the git commands used below are summarized in Git Cheatsheet in the How-To chapter.

Download Trafodion Source Tree

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

...

Change TypeRefer To...
CodeModify Code
QA TestsModify Tests
DocumentationModify Documentation
Web SiteModify Web Site

Commit Changes 

Note
titleRun Regression Tests

If you’re making code changes, then ensure that you run the Regression Tests before committing changes.

...

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.

  • Modify Documentation: You can modify the Trafodion documentation without creating the Trafodion Build Environment or Trafodion Test Environment. Typically, contributors working on the Trafodion code also modify the Trafodion Documentation when making changes.

  • Modify Web Site: You can modify the Trafodion web site without creating the Trafodion Build Environment or Trafodion Test Environment.