TubeTK/Git/Develop
_NOTOC__
This page documents how to develop TubeTK through Git. See our table of contents for more information.
Git is an extremely powerful version control tool that supports many different "workflows" for indivudal development and collaboration. Here we document procedures used by the TubeTK development community. In the interest of simplicity and brevity we do not provide an explanation of why we use this approach. Furthermore, this is not a Git tutorial. Please see our Git resource links for third-party documentation, such as the ProGit Book.
Setup
Before you begin, perform initial setup:
1. Register Git push access. | |
2. Follow the download instructions to create a local TubeTK clone: | |
|
|
3. Run the developer setup script to prepare your TubeTK work tree and create Git command aliases used below: | |
|
Workflow
TubeTK development uses a branchy workflow based on topic branches. Our collaboration workflow consists of three main steps:
1. Local Development |
2. Code Review |
|
3. Integrate Changes |
|
Update
Update your local master branch: | |
|
|
Create a Topic
All new work must be committed on topic branches. Name topics like you might name functions: concise but precise. A reader should have a general idea of the feature or fix to be developed given just the branch name.
To start a new topic branch: | |
|
|
Edit files and create commits (repeat as needed): | |
|
When a topic is ready for review and possible inclusion, share it by pushing to the topic stage.
Only authorized developers with Git push access to tubetk.org
may perform this step.
Checkout the topic if it is not your current branch: | |
|
|
Check what commits will be pushed to the topic stage: | |
|
|
Push commits in your topic branch to the topic stage: | |
|
|
The topic is now published on the TubeTK Topic Stage and may be (optionally) reviewed by others. To fetch staged topics for review, run | |
|
Revise a Topic
If a topic is approved after review, skip to the next step. Otherwise, revise the topic and push it back to the topic stage for another review.
Checkout the topic if it is not your current branch: | |
|
|
To revise the | |
(Substitute the correct number of commits back, as low as Follow Git's interactive instructions. |
|
Return to the previous step to share the revised topic. |
Merge a Topic
After a topic has been reviewed and approved, merge it into the upstream repository.
Only authorized developers with Git push access to igstk.org
may perform this step.
Checkout the topic if it is not your current branch: | |
|
|
Merge the topic: | |
|
|
Delete a Topic
After a topic has been merged upstream, delete your local branch for the topic.
Checkout and update the master branch: | |
|
|
Delete the local topic branch: | |
|
|
The |