Getting Started as a Contributor

Requirements

Node >= 8 and yarn > =1.6.0 are required for both PatternFly 3 and PatternFly 4.

Learning React

We highly recommend React's Documentation. This contains up to date information on React from the project's core maintainers at Facebook.

Our team has also put together some resources for learning React!

• Notes for React Beginners by Mike Turley (@mturley)
• Getting Started w/ React by Patrick Riley (@priley86)

Docs

PatternFly 3

PatternFly 3 uses React Storybook to demonstrate React UI components and patterns. You can read more about Storybook UI Development in its README.

You can run PatternFly 3 docs locally using:

yarn start:pf3

When you create a PR our CircleCI job will automatically make a storybook for you and upload a preview link.

PatternFly 4

PatternFly 4 uses Gatsby to demonstrate React UI components and patterns. You can read more about how to write your own docs and how its configuration works in its README.

You can run PatternFly 4 docs locally using:

yarn start:pf4

When you create a PR our CircleCI job will automatically build our docs for you and upload a preview link.

Testing

Both PatternFly 3 and PatternFly 4 use Jest for running tests. We use Airbnb's Enzyme to render components using our own snapshot-serializer.