Git Setup

Chris Shinn edited this page Dec 6, 2016 · 6 revisions

(do this part once)

For a visual diagram of this process, click here

GitHub

  1. First, you will need to register for an account on GitHub or sign in.
  2. Go to the PatternFly-Design Repo on GitHub
  3. Click on Fork in the top right

    • If it asks Where should we fork this repository?, you will want to fork it to your personal GitHub account

    Creating a fork on GitHub

SourceTree

  1. Download SourceTree
  2. Open the SourceTree App (create an account if necessary or sign in with google. Your Jira account will not work)
  3. On the Connect an account page, select GitHub and sign in with your GitHub credentials, then click Continue

    Signing into Github from SourceTree

  4. On the Clone a repository page, scroll until you see the line named <yourgithubusername>/patternfly-design and select it.

  5. In the Destination field, type or browse for the folder in which you would like to store your local copy of patternfly-design. Next, click Clone.

    Cloning a repository in SourceTree

  6. SourceTree will present you with a list of your repositories. Make sure you are on the Local tab and double click on your patternfly-design repository.

    Viewing a local repository

  7. Go to Repository > Add Remote

    Adding a remote repository

    • Name it upstream (make sure to use lowercase) and paste in the URL https://github.com/patternfly/patternfly-design.git
    • Note: upstream is the main repository and origin is your personal fork

    Adding a remote repository

  8. Click on the Fetch button, then click OK

    Fetching in SourceTree

You're ready to start making contributions!

Read the contribution workflow guide here