Contribute to PatternFly

Community contributions

Thank you for your interest in contributing to PatternFly! We depend on community contributions to help our design system grow and evolve. We encourage everyone, regardless of background, to get involved. Common contributions include (but aren't limited to):

  • New feature ideas.
  • Bug reports.
  • Documentation updates.

This guide outlines the ways that you can contribute to PatternFly's design, code, and documentation to help us stay on top of the latest and greatest solutions.

If you have any ideas that don't fit into the projects outlined in this guide, please reach out to us on Slack.

Design

If you have skills in visual and interaction design, you can contribute to PatternFly's design by taking an existing issue or proposing a new feature, enhancement, or icon. If you are interested in any of these projects, reach out on the patternfly-design Slack channel.

Existing design issues

The PatternFly design team is composed of visual and interaction designers who define the look and feel of the PatternFly library. The team follows an agile framework, planning their work in sprints, with a backlog that is tracked and managed via this GitHub project board. This board contains a list issues that are currently unassigned and waiting in the queue. If you see something here that you'd like to work on, leave a comment on the issue and a member of our team will reach out with next steps.

New feature or enhancement

If you have an idea for a new design pattern, a new component type, or an existing feature improvement, we'd love to hear it. Start by opening an issue in the patternfly-design repository. From there, a member of our team will reach out and work with you to plan and design a solution.

New icons

We encourage designers to work with the existing PatternFly icon set, which covers most common use cases. If your use case isn't covered, you can propose a new icon.

To contribute a new icon, start by opening an issue in the patternfly-design repository that describes your idea and why it's needed. A member of our team will reach out to you to discuss next steps.

Code

The primary PatternFly libraries include HTML/CSS (commonly called "core") and React. If you're looking to contribute to PatternFly's codebase, these libraries are a good place to start. You can help out by taking existing issues, or creating issues for bugs and other changes.

If you have any questions about these projects, you can reach out to us on our patternfly-core and patternfly-react Slack channels.

Existing development issues

To find work that has been approved, but not started, you can view open issues in our patternfly (HTML/CSS) and patternfly-react (React) repositories. If you find an issue that you'd like to work on, leave a comment and someone from our team will reach out to you with next steps.

Be sure to view our detailed contribution instructions for both of these repositories:

Bug reports

If you believe that you've come across a PatternFly bug, alert our team, so that we can resolve the issue. To report a bug, follow these steps:

  1. View the documentation for the feature, to confirm that the behavior is not functioning as intended.
  2. Search open issues in the patternfly and patternfly-react repositories to see if a related issue already exists.
  3. Be sure to mention which project the bug was noticed in and if there is a deadline that the fix is needed for.

Documentation

Across our website, you can find PatternFly documentation that explains concepts, provides guidance, and outlines important resources for PatternFly users. Our documentation can always be improved, and we love to hear input from the people who use it.

If you'd like to contribute to documentation, you can refer to our detailed contribution instructions for additional guidance.

Existing documentation issues

Our website documentation is contained in the patternfly-org repository. If you find an issue that you'd like to work on, leave a comment and someone from our team will reach out to you with next steps.

Design guidelines

Our design guidelines are found across our component, layout, chart, and pattern web pages. These guides clarify usage details to help designers follow best practices to create strong UI solutions.

If you'd like to contribute to our design guidelines, you can open an issue in patternfly-org to propose a new page or updates to an existing page. From there, our team will work with you to author and publish your new content.


View source on GitHub