Skip navigation
NASA Logo, National Aeronautics and Space Administration
Currently Being Moderated

GitHub collaboration guide

VERSION 1 
Created on: May 28, 2019 9:17 AM by Carlos Cruz - Last Modified:  May 28, 2019 9:26 AM by Carlos Cruz

Please follow the following steps when forking and/or creating a pull request.

The guide below assumes you are forking NU-WRF from the NASA GitHub

However, the guide is a general "fork-pull request" workflow applicable on any GitHub server.

Just change the URL.

 

Fork Nu-WRF

 

 

On the GitHub page, click the "Fork" button.

This should create a copy the the nu-wrf repo on your GitHub account.

Take note of the URL.

 

 

Once you've done that, head straight to the command line to clone your forked repo:

 

 

# Clone your fork to your local machine

git clone https://developer.nasa.gov/YOUR-USERNAME/nuwrf

 

 

Keeping Your Fork Up to Date

 

 

While this isn't an absolutely necessary step, if you plan on doing anything more

than just a tiny quick fix, you'll want to make sure you keep your fork up to date

by tracking the original "upstream" repo that you forked. To do this, you'll need

to add a remote:

 

 

# Add 'upstream' repo to list of remotes

git remote add upstream https://developer.nasa.gov/NU-WRF/nuwrf

 

 

# Verify the new remote named 'upstream'

git remote -v

 

Whenever you want to update your fork with the latest upstream changes, you'll

need to first fetch the upstream repo's branches and latest commits to bring them

into your repository:

 

 

# Fetch from upstream remote

git fetch upstream

 

 

# View all branches, including those from upstream

git branch -va

 

 

Now, checkout your own master branch and merge the upstream repo's master branch:

 

 

# Checkout your master branch and merge upstream

git checkout master

git merge upstream/master

 

 

If there are no unique commits on the local master branch, git will simply perform a fast-forward.

However, if you have been making changes on master (in the vast majority of cases you probably

shouldn't be) you may have to deal with conflicts. When doing so, be careful to respect the changes made upstream.

 

 

Now, your local master branch is up-to-date with everything modified upstream.

 

 

Doing Your Work

 

 

Create a Branch

 

Whenever you begin work on a new feature or bugfix, it's important that you create a new branch.

Not only is it proper git workflow, but it also keeps your changes organized and separated from

the master branch so that you can easily submit and manage multiple pull requests for every task

you complete.

 

 

To create a new branch and start working on it:

 

 

# Checkout the master branch - you want your new branch to come from master

git checkout master

 

 

# Create a new branch named newfeature (give your branch its own simple informative name)

git branch newfeature

 

 

# Switch to your new branch

git checkout newfeature

 

 

Submitting a Pull Request

 

 

Cleaning Up Your Work

 

Prior to submitting your pull request, you might want to do a few things to clean up your

branch and make it as simple as possible for the original repo's maintainer to test, accept,

and merge your work.

 

 

If any commits have been made to the upstream master branch, you should rebase your

development branch so that merging it will be a simple fast-forward that won't require any

conflict resolution work.

 

 

# Fetch upstream master and merge with your repo's master branch

git fetch upstream

git checkout master

git merge upstream/master

 

 

# If there were any new commits, rebase your development branch

git checkout newfeature

git rebase master

 

 

Now, it may be desirable to squash some of your smaller commits down into a small

number of larger more cohesive commits. You can do this with an interactive rebase.

 

 

# Rebase all commits on your development branch

git checkout

git rebase -i master

 

 

This will open up a text editor where you can specify which commits to squash.

 

 

Submitting

 

 

Once you've committed and pushed all of your changes to GitHub, go to the page for

your fork on GitHub, select your development branch, and click the pull request button.

If you need to make any adjustments to your pull request, just push the updates to GitHub.

Your pull request will automatically track the changes on your development branch and update.

Comments (0)
USAGov logo NASA Logo - nasa.gov