THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
This guide describes how to contribute to the Trafodion project.
Document Table of Contents
Intended Audience
Contributing to the Trafodion project is open to every person interested in the improvement of its product(s) and/or its
community; anyone willing to further the project.
If you want to do more; for example, be recognized for your commitment or be eligible for privileges (privileges to commit
changes to the code base or have a binding vote on the directions of this project), then please follow steps herein.
Organization
| Category | Chapter | Content |
|---|---|---|
| Contribute | Introduction | Provides an overview of how to contribute to the Trafodion project. |
| Advocate | Advocate | Discusses how to help the Trafodion project through advocacy such as social media, meet-ups, articles, etc. |
| Contribute | Getting Started | Documents how to become a registered Trafodion and the setup required to Document and/or Develop Trafodion |
| Develop | 4. Create Build Environment | Provides instructions for how to set up the Trafodion build environment. |
| Develop | Build Source | Explains how to build the Trafodion source code. |
| Develop | Create Test Environment | Describes how to set up the Trafodion test environment. |
| Develop | Manage Test Environment | Discusses how to manage the Trafodion development environment. |
| Develop | Test | Contains information for how you test Trafodion. |
| Develop | Defect Management | Describes how the Trafodion project manages defects. |
| Develop | Modify Code | Explains code organization, provides coding guidelines, and other information related to the Trafodion code. |
| Develop | Modify Tests | Documents the test-library organization and explains how to add and modify individual tests and test libraries. |
| Develop | Modify Documentation | Contains information about how to add and modify the Trafodion documentation, which is written in asciidoc. |
| Develop | Modify Web Site | Explains how to modify the Trafodion web site, which is written in markdown and built using Maven. |
| Develop | Modify Wiki | Describes how to modify the Trafodion wiki pages, which are based on the Confluence wiki software. |
| Commit | Merge Changes | Provides information about how a committer reviews and approves pull requests. |
| Commit | Create Release | Discusses the steps used to create a new Trafodion release. |
| How-To | How-To | Contains how-to information referenced from other chapters in this guide. |
Categories are not exposed in the web book or PDF version of this guide; they are intended to help you get a picture of the different parts of Trafodion contribution.
The Trafodion web site provides direct-links to the different chapters as well as links to the overall guide. You choose what access methods that works best for your style of working.
Notation Convention
This table summarizes the notation conventions for syntax presentation in this guide.
| Convention | Description | Example |
|---|---|---|
| UPPERCASE LETTERS | Uppercase letters indicate keywords and reserved words. Type these items exactly as shown. Items not enclosed in brackets are required. | SELECT |
| lowercase letters | Lowercase letters, regardless of font, indicate variable items that you supply. Items not enclosed in brackets are required. | file-name |
[ ] Brackets | Brackets enclose optional syntax items. | A group of items enclosed in brackets is a list from which you can choose one item or none. The items in the list can be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines. For example: |
{ } Braces | Braces enclose required syntax items. | FROM { grantee [, grantee ] ... }A group of items enclosed in braces is a list from which you are required to choose one item. The items in the list can be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example: INTERVAL { start-field TO end-field } { single-field }
INTERVAL { start-field TO end-field | single-field } |
| Vertical Line | A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. | |
| ... Ellipsis | An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times. | ATTRIBUTE[S] attribute [, attribute] ...
{, sql-expression } ...An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times. For example: expression-n ... |
| Punctuation | Parentheses, commas, semicolons, and other symbols not previously described must be typed as shown. | DAY (datetime-expression) @script-file Quotation marks around a symbol such as a bracket or brace indicate the symbol is a required character that you must type as shown. For example: "{" module-name [, module-name] ... "}" |
| Item Spacing | Spaces shown between items are required unless one of the items is a punctuation symbol such as a parenthesis or a comma. | If there is no space between two items, spaces are not permitted. In this example, no spaces are permitted between the period and any other items: |
| Line Spacing | If the syntax of a command is too long to fit on a single line, each continuation line is indented three spaces and is separated from the preceding line by a blank line. This spacing distinguishes items in a continuation line from items in a vertical list of selections. | |