...
- Sign up for Bitbucket account
- Go to http https://bitbucket.org/lorainelab/integrated-genome-browser (the team repository)
- Select Fork
Next, you'll see a form that let's you give your fork a name and description. Here's an example:
Fill in the fields and click Fork repository.
After a moment, an Overview page for your forked repository will appear.
...
- Create a fork (top left)
Tip: Sign up using an academic .edu address to gain access to more features.
Clone your fork
Clone a copy of your forked IGB repository onto your computer. You will make changes to your local clone, commit them to your local repository, and then ultimately push your changes to your fork hosted on Bitbucket.
...
Note: Topic branches are sometimes also called "feature branches." However, this is may not be the best name because often branches deal with bug fixes or improvements to existing features. The IGB project prefers the term "topic branch" is a better name because it is covers more generaloptions.
Edit code, commit to your clone, push to your fork
...
- Push to the remote repository, aliased to "origin". (This is a default setting in git.)
| Code Block |
|---|
git push origin BRANCH |
...
Now the master branch is up-to-date on your clone and fork.
Note: You can also use the Bitbucket Web site to do this. Visit your fork's Web site and use the right-side menu to synchronize your fork.
Rebase your branch
After updating your clone and fork with the latest changes to the master branch, you'll need to test how those new commits interact with your topic branch. The IGB team recommends you You should use "rebase" commands to do this. This will move the "base" of your topic branch to the latest commit on the master branch.
To rebase your branch on the latest master, update switch back to the master branch, synchronize your fork's master branch with the team repository (see above), check out your feature branch, and rebase:
...
To request that your edits be incorporated into the team repository - aliased to "upstream" - you need to issue make a pull request.
- Go to your fork's project Overview page and click the branches link
- Go to the branch you want to merge
- Select Create Pull Request
...
- 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 the team repository already has dozens of branches, most of them leftover from older workflows. DON'T push your branch as an all-new branch to the team repository. And DON'T merge your branch with master.
Other info
GenoViz Software Development Kit
IGB uses graphical user interface components in the GenoViz Software Development Kit. Normally, when you build IGB, you'll use a copy of the GenoViz SDK downloaded from our maven repository at http://eos.transvar.org/nexus/. However, if you clone and build your own copy, your version will automatically get added to your local maven repository.
Building javadocs
To build javadocs, run
...