Skip to content

Commit 8a4b05f

Browse files
authored
Update README.md
Updated the README to display more accurate information on the PatternFly 6 Design Kit enhancements, contributions steps and questions.
1 parent 8f33991 commit 8a4b05f

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,38 @@
11
# PatternFly Design Kit
2-
**The PatternFly Design Kit** is a collection of [Sketch](https://www.sketchapp.com) assets that make it easy for designers to create low and high-fidelity design mockups that accurately represent [PatternFly](http://patternfly.org) components and layouts. It includes:
2+
**The PatternFly Design Kit** is a collection of Figma components that make it easy for designers to create low and high-fidelity design mockups that accurately represent the [PatternFly](http://patternfly.org) components and layouts.
33

4-
* **A sketch symbol library:** includes components, icons, color palettes, and other PatternFly elements. Hosted on Sketch Cloud [here](https://www.sketch.com/s/2cf1063b-5283-4e0b-b8a6-cbb1ac07e29e).
5-
* **A template file:** provides several starter layouts that will make it easier to construct common PatternFly screens. Hosted on Sketch Cloud [here](https://www.sketch.com/s/729c2eee-e8b6-4fcd-8a79-f6faa8c30f89).
6-
* **A wireframe kit:** includes a collection of low fidelity and mid fidelity PatternFly components and layouts. It includes:
7-
* A Wireframe library that allows you to design and iterate designs more quickly before upgrading them to high fidelity. Hosted on Sketch Cloud [here](https://www.sketch.com/s/97d92966-7ad7-4207-a381-48fda3c080f8).
8-
* A Wireframe template file that provides examples of low fidelity components in a context. Hosted on Sketch Cloud [here](https://www.sketch.com/s/0af9fc12-7b9e-49c1-8d36-a6a62385a413).
9-
* For more detailed information about Wireframe kit, go [here](/PatternFly%204%20-%20Wireframe%20library%20and%20template/Wireframe%20kit%20guideline.md).
4+
The PatternFly 6 design kit gives you access to:
5+
6+
* Our complete component library.
7+
* Our design token system.
8+
* Demos and patterns of full-screen designs.
9+
10+
The figma design kit includes:
11+
12+
* **[PatternFly 6: Component library](https://www.figma.com/community/file/1357060119827689328/patternfly-6-components)** – includes all standard components and icons
13+
* **[PatternFly 6: Patterns & Extensions Library](https://www.figma.com/community/file/1357062621908564852/patternfly-6-patterns-extensions)** – provides several patterns and demos that solve common UI problems by grouping multiple PatternFly components into reusable layouts
14+
* **[PatternFly 6: Design Tokens & Styles](https://www.figma.com/community/file/1357058122244711273/patternfly-6-design-tokens-styles)** – contains all the variables for color, spacing and typography that convey the associated design style for PatternFly
1015

1116
## Updating the kit
12-
Sketch will automatically receive library updates in the top, right corner of an open Sketch file. You'll want to update the PatternFly library **and** update the symbols within your file (two separate notifications). You'll have to update **all** files that are using PatternFly symbols - it is not a one and done process, unfortunately.
17+
The PatternFly team will release updates accordingly as part of their sprint schedule. Be sure to revisit our [Figma community page](https://www.figma.com/@patternfly) in order to download the latest updates.
18+
If you are working in the main community file, Figma will automatically receive library updates. If you are working from a local file, you will not receive automatic updates and will need to update the PatternFly library manually.
1319

14-
To update you PatternFly Template file, open the updated template from your local repo and select **File > Save as Template...** This will replace the current template with the updated version and make the latest layouts available using the **New from Template...** feature.
1520

1621
## Filing bugs
17-
If something isn't working as expected with the library or template file, please file an issue in this repo and label it with "bug". We should be able to fix it within a couple days!
18-
If something is wrong with the Wireframe kit, please contact Alessandro Contini [acontini@redhat](mailto:[email protected]) or file an issue in this repo.
22+
If you believe that you've come across a PatternFly Design Kit bug, alert our team, so that we can resolve the issue. To report a bug, follow these steps:
23+
1. View the documentation for the feature to confirm that the behavior is not functioning as intended. Friendly Reminder: We try our best to match the component within Figma to what is represented on patternfly.org. Double check to verify that this is a Figma design kit bug vs. a general design enhancement.
24+
2. Search open issues in this repo to see if a related issue already exists.
25+
3. File an issue in this repo and label it with "bug". If something is wrong with any of the Figma libraries, please contact Lucia Boehling, Kayla Chumley or Bekah Stephens.
1926

20-
## Contributing to the PatternFly Design Kit
21-
We welcome contributions from our community of PatternFly designers. Please contact Lucia Boehling (@lboehling) on the #patternfly-design-kit channel within the [patternfly.slack.com Slack workspace](https://patternfly.slack.com).
22-
### Contributing a new or edited symbol
23-
Follow these steps:
24-
1. Download the library file from [here](https://www.sketch.com/s/2cf1063b-5283-4e0b-b8a6-cbb1ac07e29e).
25-
2. Create new symbols or edit symbols using the styles and elements from "Document".
26-
**Be sure you take them from "Document" rather than "PatternFly"**
27-
3. When naming a new symbol, follow the naming mechanism within that same category (e.g., Forms / 2. Text Box / Success).
28-
4. Make it clear which page in the file you edited and which symbols on the page you added/edited by adding a ⭐️ or some other mark to call them out.
29-
5. Zip your file and attach it to the GitHub issue you were assigned to. Add a list of the symbols you added/edited and, finally, tag @lboehling in your comment.
30-
### Contributing a new or edited template
27+
28+
## Contributing to the kit
29+
We welcome contributions from our community of PatternFly designers. Reach out to the team within the [patternfly.slack.com workspace](http://patternfly.slack.com) via the #patternfly-design-kit channel, and our team will assist with questions on design kit enhancements.
30+
31+
### Contributing a new or edited component, pattern, or extension
3132
Follow these steps:
32-
1. Download the template file hosted on Sketch Cloud from [here](https://www.sketch.com/s/729c2eee-e8b6-4fcd-8a79-f6faa8c30f89).
33-
2. If the template you're working on fits within an existing page, create a new artboard and add it to that page. If it doesn't fit into an existing page, create a new page and then add artboards from there.
34-
3. Be sure to add all padding specific to that example in it's own folder within the layer list called "📐Padding" and hide it.
35-
4. If the design variation is new and needs a spec, add it to the first artboard, add it's name (use the comment text style), and unhide the "📐Padding" group (see the template file for existing examples of how this is done now).
36-
5. Zip your file and attach it to the GitHub issue you were assigned to. Add a list of pages you added/edited and the artboards on those pages. Finally, tag @lboehling in your comment.
33+
1. Create a copy of the PF6 Design Kit Figma file you are working from or create a new branch hosted in Figma.
34+
2. If the concept you're working on fits within an existing design, add it to that existing component/pattern/layout page tab. If it doesn't fit into an existing component/pattern/layout, create a new page and then start fresh from there.
35+
3. Copy a link to your Figma file or branch and attach it to the GitHub issue it is related to. Add your contribution or enhancement topic to the [PatternFly & UXD Design Share agenda](https://docs.google.com/document/d/1sZDSHsC5LZM1-7EvoYF4idji83TcZ7FargqRuifai_8/edit?tab=t.0#heading=h.cmjge5yxw5ee). Discuss your contribution idea with the broader team. Be sure to send a Slack message to the PatternFly design team for additional support.
36+
3737
### Questions?
38-
If you have any questions or concerns, please contact Lucia Boehling [[email protected]](mailto:[email protected]).
38+
If you have any questions or concerns, please contact Lucia Boehling, Kayla Chumley, Bekah Stephens, or Andrew Ronaldson.

0 commit comments

Comments
 (0)