First‐time setup for contributors

Note: You can refer to this resource to learn about GitHub terminology and concepts.

Table of contents

• Step 1—Fork the repo
• Step 2—Configure your local environment
• Step 3—Set up VS Code

---

Step 1—Fork the repo

1. Before you can contribute content, you’ll need to fork the upstream patternfly-org repo to your GitHub account.
   • Create a GitHub account if you don’t already have one.
   • Once you’re logged in to GitHub, go to the patternfly-org repo.
2. Fork the repo.

   • In the top right-corner, under your GitHub icon, click fork:

     

   • Select create fork in the prompt that appears:

     

---

Step 2—Configure your local environment

1. Create a folder in your computer’s Documents folder to store the repo content, and name it “repos”.
2. Clone the repo to this file location. If you already know how to clone you can do so and jump to the next step. Otherwise, follow these steps:
   1. Open your computer’s terminal.
   2. Type pwd and press Enter. This tells you where you’re located within your computer, like which directory you’re in and what files are listed there.
   3. Change directories based on where you want to install the repo. To install in the folder that you just made (/Users/username/documents/repos):
      • Type cd documents and press Enter
      • Type mkdir -p repos and press Enter
      • Type cd repos and press Enter
      • Type git clone, followed by the URL for your patternfly-org GitHub fork:

        • git clone https://github.com/yourGitHubName/patternfly-org.git. Replace “yourGitHubName” with your GitHub username. For example, if your GitHub name is “mmenestr”, you would use: git clone https://github.com/mmenestr/patternfly-org.git.

        • When submitting the command, you may get a pop-up prompting you to install something:

          

          If you do, click Install and continue.

        • After installing, re-type the original command, remembering to replace “yourGitHubName” with your GitHub username.

      • Type cd patternfly-org and press Enter.
      • Type git remote add upstream https://github.com/patternfly/patternfly-org.git and press Enter.

---

Step 3—Set up VS Code

1. Download Microsoft Visual Studio Code (VS Code) or your code editor of choice. Note that our contribution instructions will refer to VS Code, but you can adapt them to your own editor.

2. In VS Code, open the patternfly-org file that you just created.

   

3. To turn on auto save, go to Code > Preferences > Settings:

   

   In Settings, change "Files: Auto Save" to "afterDelay":

   

---

You're done! Now, you're ready to follow our contribution guide.

---

Get help

If you run into issues with this guide, or if you have any questions, reach out to Erin Donehoo (edonehoo).