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 iota.
- Tools and Guidelines: Familiarize yourself with the tools and guidelines used to develop iota.
- 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 iota contributor before you can help us develop iota. Please perform the following registration actions:
| Area | Notes | URL |
|---|---|---|
| Individual Contributor License Agreement (ICLA) | You should sign the ICLA before contributing content to the iota source tree. (Required to become a committer.) | ICLA Agreement Approval Process |
| Source Control | You need a github account in order to participate in iota code reviews. If you haven’t already done so, please join github. | 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 iota 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 iota. You will be added (by designated space admins) to:
- The iota Confluence Contributors group, so that you can add new and edit existing wiki pages.
- The iota 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 |
|---|---|---|---|
| iota Architecture | Document | Please review the iota architecture to ensure that you understand how the different components related to each other. | iota Architecture |
| Defect Tracking | Jira | View all the iota defects and enhancements requests in the Jira system hosted by Apache. | iota 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 iota 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 iota source tree can be retrieved from either of these repositories. | Apache Repository GitHub Mirror |
| Code Organization | Document | If you intend to work on the iota code, then please familiarize yourself with the code organization. | TBD |
| Testing | Document | iota 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. | 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 |
Learn iota
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.
- Create Build Environment
- Build the iota Source Code
- Create Test Environment
- Run some of the tests in the iota test libraries.
- Use the iota documentation to install iota clients and play around with the different capabilities.
- Learn how we manage defects.
- Familiarize yourself with the iota Development Workflow.
Once you've reached this point, then you make changes to the iota source tree depending on interest area:
We're glad your interested in helping us grow iota. If you have any question, send an e-mail to dev@iota.incubator.apache.org.