Setting Up Your Git Environment

This page is for you if you are a first time contributor to PBS Pro (or returning after an extended vacation).

Each developer works with three PBS Pro repositories:

The "golden" repository, on GitHub at https://github.com/PBSPro/pbspro
The developer's fork of the "golden" repository, on GitHub at https://github.com/<your-name-here>/pbspro
The developer's clone of the forked repository, on the developer's local machine

Create a GitHub account if you don't have one already.
Install Git on your local machine.
Go to the PBS Pro golden repository on GitHub: https://github.com/PBSPro/pbspro.
Create a fork of the golden repository.
Clone the forked repository to your local machine:
git clone https://github.com/<your GitHub user name>/pbspro.git
Go inside the cloned directory:
cd pbspro
Configure your Git name and email (<username>@emaildomain.com: your email ID)
git config --global user.name "<your name>"
git config --global user.email <username@emaildomain.com> (your email)
Note: You may skip --global if you want to use this configuration only for the PBS repository.
Add a remote called "upstream" (we use this convention) for the golden repository
git remote add upstream https://github.com/PBSPro/pbspro.git
OPTIONAL: Create and set up your GPG signature to use when you sign your commits. If you want, you can sign your commit before your pull request is merged into the golden repository.