| Table of Contents |
|---|
To develop IGB , we use and the IGB API, the core IGB development team uses the Forking Workflow described in https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow
The following sections describe how to use this workflow to develop IGBmodify IGB. This assumes you understand the basics of how to use git but are unfamiliar with the forking workflow.
...
Fork the code on Bitbucket
...
Fill in the fields and click Fork repository.
After a moment, the an Overview page for your forked repository will appear.
...
Before you start making changes to your local clone, you should first create a new branch for the changes you intend to make. This will allow you to issue focused, low risk pull requests that can be easily merged are easy to merge with other developers' work.
...
where BRANCH is the name of the branch, e.g., IGBF-203, the name of a story in the IGB JIRA issue-tracking system. In this example, BRANCH is branched from the master branch, the main line of development for IGB.
Edit code, push to your fork
...
| Code Block |
|---|
git push origin BRANCH |
Issue pull request
To request that your edits be incorporated into the main line of development:
- Go to your fork's project Overview page
- Select Create Pull Request
A pull request form will appear. Fill in the fields:
- Select your branch (see above) as the pull request source (left side).
- Select the master branch as the pull request target (right side).
- Fill in the Title and Description fields
- Click Create pull request
Note that "origin" is aliased to your fork on Bitbucket, not the team repository.
Synchronize with the main repository
If the main development branch changes, you should merge those changes into your fork early and often.
To bring your remote fork up-to-date::
- Add the original, main IGB repository as a remote git repo with the alias "upstream"
...
| Code Block |
|---|
git push origin master |
Issue pull request
To request that your edits be incorporated into the team repository - aliased to "upstream".
- Go to your fork's project Overview page
- Select Create Pull Request
A pull request form will appear. Fill in the fields:
- Select your branch (see above) as the pull request source (left side).
- Select the master
...
- branch as the pull request target (right side).
- Fill in the Title and Description fields
- Click Create pull request
GenoViz Software Development Kit
...