THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
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.
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 a git account in order to contribute to the Trafodion source. If you haven’t already done so, please join git. | 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.
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 |