Clone this wiki locally
(do this whenever want to add or edit something)
Get up to date
Make sure that your local repository is selected, and click
A modal will pop up. Where is says,
Pull from repository, select
upstreamfrom the drop down menu. Where it says
Remote branch to pull:select
masterfrom the drop down menu. Check the box that says
Rebase instead of merge
Create or update the pattern
We recommend using Atom to edit .md files. You can reference the GitHub Markdown files for help formatting.
- Use Finder to open up your patternfly-design folder
- Locate the folder for the pattern you hope to edit under pattern-library
- If the folder does not exist, copy the pattern-template folder, paste it in the relevant location, and rename it
- Add and edit the relevant files and images. Feel free to discard example and placeholder content from the pattern-template folder.
Commit (save) your changes
Click on the
Commitbutton in the toolbar
Check the boxes next to any files that you wish to include (checking
Unstaged fileswill automatically move them all over) They will move from
Add a description (usually 55 characters or fewer) of your edits.
A modal will pop up, make sure
originis selected where it says
Push to repositoryand select the branch you wish to push then click
You should then see that your local and remote (origin) repos are synchronized.
Create a Pull Request (submit your changes to Patternfly)
Repository > Create Pull Request
Ensure that the
Submit Via remotefield is set to
originand that the other two fields are set to
Click Create Pull Request on Web. SourceTree will open a browser window on GitHub for you.
Create a Pull Request, add a comment if relevant.