THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
| Excerpt | ||
|---|---|---|
| ||
Documents how to become a registered Trafodion contributor and the setup required to document and develop Trafodion. |
...
| Table of Contents |
|---|
...
You need to do the following to get started:
...
- Contributor Registration: Sign up with the tools used to develop Trafodion.
- Tools and Guidelines: Familiarize yourself with the tools and guidelines used to develop Trafodion.
- Development Workflow: Familiarize yourself with how to work with git, make changes, commit changes, and generate pull requests.
- Next Steps: Decide where to go next in this guide depending on your intended contribution.
| Anchor | ||||
|---|---|---|---|---|
|
Contributor Registration
You need to register as a Trafodion contributor before you can help us develop Trafodion. Please perform the following registration actions:
| Area | Notes | URL |
|---|---|---|
| Individual Contributor License Agreement (ICLA) | You should sign the ICLA before contributing content to the Trafodion source tree. (Required to become a committer.) | ICLA Agreement Approval Process |
| Source Control | You must have need a git github account in order to contribute to the Trafodion sourceparticipate in Trafodion code reviews. If you haven’t already done so, please join gitgithub. | Git Sign-up |
| Defect Tracking | In order to have certain permissions, including assigning issues to yourself, you need to be a Contributor in the project. Be sure to sign up for a JIRA account if you don’t have one. | Jira Signup |
Please send an e-mail to the Trafodion development list with the approved ICLA attached. Include your git and Jira IDs. Wait for the response and then you’re ready to help us develop Trafodion. You will be added (by designated space admins) to:
- The Trafodion Confluence Contributors group, so that you can add new and edit existing wiki pages.
- The Trafodion JIRA Contributors group, so that you can assign yourself to any open issue in order to bring it further to resolution and/or closure.
| Anchor | ||||
|---|---|---|---|---|
|
Tools and Guidelines
| Area | Tool | Notes | Location |
|---|---|---|---|
| Trafodion Architecture | Document | Please review the Trafodion architecture to ensure that you understand how the different components related to each other. | Trafodion Architecture |
| Defect Tracking | Jira | View all the Trafodion defects and enhancements requests in the Jira system hosted by Apache. | Trafodion Jiras |
| Defect Management | Document | Please read about our approach to defect management. Mostly, any changes you’ll make will be in response to a defect reported in Jira. | Defect Management |
| Git Tools | git | Most of the Trafodion development is done on Linux. Development of the web site and/or documentation can successfully be done on Windows. | Install Git Tools |
| Code Repository | git | The full Trafodion source tree can be retrieved from either of these repositories. | Apache Repository GitHub Mirror |
| Code Organization | Document | If you intend to work on the Trafodion code, then please familiarize yourself with the code organization. | Code Organization |
| C++ Coding Guidelines | Document | Please read the coding guidelines for the Trafodion C++ code before making changes. | C++ Coding Guidelines |
| Debugging Tips | Document | Documented tips describing how to debug your code in unit testing. | Debugging Tips |
| Testing | Document | Trafodion has a rich set of test suites for each of its components. You’ll need to run the tests before submitting a code change for review. | How to Test |
| Code Reviews | git | We use GitHub pull-requests for code review. All of the activity on GitHub is captured in ASF JIRA and/or ASF project mail archives by ASF INFRA team automation. In this way, we do not depend on GitHub for accurate history of where contributions come from. Each pull-request title should start with a JIRA ID in brackets, so that activity can be logged to the correct JIRA issue. Regardless of the title, the pull-request activity is also logged to the Code-Review Mail List. | Current Pull Requests |
Development Workflow
The following provides a basic overview of how we develop Trafodion.
Install Git Tools
You use git to make changes to the Trafodion code, tests, documentation, and web siteLearn Trafodion
Starting out, we recommend the following approach:
- 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.
| Info | ||
|---|---|---|
| ||
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.
- Create Build Environment
- Build the Trafodion Source Code
- Create Test Environment
- Run some of the tests in the Trafodion test libraries.
- Use the Trafodion documentation to install Trafodion clients and play around with the different capabilities.
- Learn how we manage defects.
- Familiarize yourself with the Trafodion Development Workflow.
Once you've reached this point, then you
Fork Trafodion Repository
You create a private fork of Trafodion on https://github.com/apache/incubator-trafodion. Use the fork button top-right on the page to create your fork, which will be named <your-git-id>_fork.
The following examples use trafdeveloper to represent <your-git-id>.
Clone Trafodion Repository
Use the git shell to perform this task.
| Code Block | ||||
|---|---|---|---|---|
| ||||
# 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 tomake 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.depending on interest area:
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.