How to Setup your Contribution Environment

Get the tools and files you need to get started!

To contribute to PatternFly you will need the following:

• A GitHub account
  First, you can register for a GitHub account on GitHub
• SourceTree This app is free and can be downloaded here. This will be used for moving your working files from your desktop, to the PatternFly-Design repository, in GitHub.
• Atom This app is free and can be downloaded here. This is an editor that you can use to format your design content as a markdown file. Markdown, or .md file is the file format that you will need for your final design contribution, to be used when creating a pull request. This file will be used to display your contribution on the PatternFly website.
• Design Resource Files Resource Sketch and Balsamiq files, to get you up and running with PatternFly assets, can be found here

Setting up 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

Let's get Started

1. Log into GitHub and Go to the PatternFly-Design Repo on GitHub

2. 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.

Great, you should now be ready to use GitHub with the PatternFly-Design repo!

Setting up 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 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 the Continue button.

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.) Now, click the Clone button.

3. 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.

4. In the SourceTree application menu, 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. In the toolbar, click on the Fetch icon, then click the OK button. 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