How to Setup your Contribution Environment

Setup GitHub

Setting up the GitHub environment, for PatternFly, is something you should only need to do once.

For a visual diagram of this process, click here

Go to PatternFly-Design on 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

Let's get Started

1. 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, for example; <yourgithubusername>/patternfly-design

Setup SourceTree

Setting up the SourceTree environment, for use with the PatternFly-Design file repository (or repo), in GitHub, is something you should only need to do once.

Connect an Account:

1. Download SourceTree
2. Open the SourceTree App (create an account if necessary, or sign in with, a the SourceTree or Google account. Your JIRA account will not work.)
3. On the Connect an account page, select the account that you will use to connect to the PatternFly-Design repo, by choosing GitHub and sign in with your GitHub credentials, then click Continue

Create a copy of the PatternFly-Design repo to your desktop

1. On the Clone a repository page, scroll until you see the line named <yourgithubusername>/patternfly-design and select it.
2. In the Destination field, type or browse for the desktop folder, in which you would like to store your local copy of patternfly-design. (This will create a local copy of the patternfly-design assets, on your desktop.) Next, click Clone.

1. SourceTree will present you with a list of your repositories. Make sure you are on the Local tab, in the upper left corner, and double click on your patternfly-design repository, located in the list.

1. Go to Repository > Add Remote

• 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, or copy of the repository.

1. Click on the Fetch button, then click OK. Fetch will import any changes, that have been committed to the remote repository, into your local repo.

You're ready to start making contributions!

Read how to make a contribution here