docs(contributing): add a contributing guide by nicolethoen · Pull Request #7585 · patternfly/patternfly

nicolethoen · 2025-06-30T18:56:16Z

patternfly-build · 2025-06-30T19:00:23Z

A11y report: https://pf-pr-7585-a11y.surge.sh

srambach · 2025-07-02T15:52:44Z

Is this replacing the contribution guide and coding guidelines at https://github.com/patternfly/patternfly/tree/main/patternfly-docs/site/pages? Also, we have those files linked from the workspace, so we should pick one and point to it from there and org.

nicolethoen · 2025-07-02T15:57:06Z

Is this replacing the contribution guide and coding guidelines at https://github.com/patternfly/patternfly/tree/main/patternfly-docs/site/pages? Also, we have those files linked from the workspace, so we should pick one and point to it from there and org.

Oh I didn't see this contribution guide - in the react Repo it was at the root. I'll rewrite this and integrate it with the files we already have. sorry about that.

mcoker · 2025-07-29T15:30:28Z

For this block -

patternfly/README.md

Lines 12 to 17 in d4085af

    
           When you install PatternFly, the package includes: 
        
           - a single file for the entire compiled library: `node_modules/@patternfly/patternfly/patternfly.css` 
        
           - individual files with each component compiled separately: `node_modules/@patternfly/patternfly/<ComponentName>/styles.css` 
        
           - a single file for the entire library's source (SASS): `node_modules/@patternfly/patternfly/patternfly.scss` 
        
           - individual files for each component's source (SASS): `node_modules/@patternfly/patternfly/<ComponentName>/styles.scss`

I wonder if it's worth calling out other files and adding info to the existing bullet points. WDYT? Also all of these styles are available via .css and .scss, so not sure if we need separate bullet points for both, or if we can just mention something like "If you want the sass version of any of these stylesheets, just specify .scss as the suffix instead of .css"

@patternfly/patternfly/patternfly-base.css - base styles. Global styles, reset/normalize styles, global variables. These styles are required for patternfly styles to work properly.
@patternfly/patternfly/patternfly.css - this is patternfly-base.css, as well as all component and layout styles. Does not include utility styles.
@patternfly/patternfly/patternfly-addons.css - all utility class styles. These do not come with patternfly.css, and must be imported manually.
@patternfly/patternfly/utilities/[UtilityName]/[utility-name].css - individual utility class styles if you prefer only use one or two, and don't want to import all of them.
@patternfly/patternfly/patternfly-charts.css - required if using dark theme with PatternFly charts.

srambach

Apologies for the big number of individual comments! I realize a few of these are out of scope of just reorganizing the contribution and guidelines. It's been a long while since we revisited these, so it's probably time for a good review.

srambach

Made another pass through. Honestly, the guidelines should probably be broken up or at least have jumplinks to the sections. 😵‍💫 But for now I made some corrections to token usage and a few other nits.

nicolethoen · 2025-08-29T15:47:08Z

I addressed your comments! Thank you so much!

Honestly, the guidelines should probably be broken up or at least have jumplinks to the sections. 😵‍💫 But for now I made some corrections to token usage and a few other nits.

I think you all can absolutely do an even more substantial rewrite or reorganization in the future! They've been so out of date for so long 😆

mcoker

Just some broken links it looks like. These pages need a good overhaul, I'll spare any comments about that 😅

slack link should be https://patternfly.slack.com/

patternfly/patternfly-docs/site/pages/contribution.md

Line 46 in d102c68

    
           - As much as possible, comments should be actionable. It should be clear to the contributor exactly what needs to change. If there are open questions that require in-depth conversation, consider meeting or using [slack](http://slack.patternfly.org) to quickly arrive at an actionable conclusion.

a11y link doesn't work. Should probably go to https://www.patternfly.org/accessibility/about-accessibility?

patternfly/patternfly-docs/site/pages/guidelines.md

Line 43 in d102c68

- Components should include semantic markup and necessary ARIA tags to implement the [accessibility guidelines](/accessibility-guide).
link doesn't work, should be https://cssguidelin.es/#80-characters-wide

patternfly/patternfly-docs/site/pages/guidelines.md

Line 317 in d102c68

- [80 Characters Wide](https://cssguidelin.es/#characters-wide)
TOC link doesn't work, should be https://cssguidelin.es/#table-of-contents

patternfly/patternfly-docs/site/pages/guidelines.md

Line 311 in d102c68

- [Table of contents](https://cssguidelin.es/#able-of-contents)

patternfly-build · 2025-09-03T18:20:57Z

🎉 This PR is included in version 6.3.0-prerelease.54 🎉

The release is available on:

Your semantic-release bot 📦🚀

nicolethoen requested a review from mcoker June 30, 2025 18:56

mcoker reviewed Jul 29, 2025

View reviewed changes

Comment thread patternfly-docs/site/pages/contribution.md Outdated

srambach reviewed Jul 29, 2025

View reviewed changes

docs(contributing): update contribution guides

f90fce4

nicolethoen force-pushed the add_contributing_guide branch from d4085af to f90fce4 Compare July 30, 2025 17:44

docs(contributing): link to PatternFly organizations AI guidance

bb7ef99

nicolethoen requested review from mcoker and srambach August 26, 2025 18:47

srambach reviewed Aug 29, 2025

View reviewed changes

fix(guidelines): address PR feedback

bfc6f60

nicolethoen added 2 commits August 29, 2025 11:50

fix(custom-icons): fix broken link

d2036ee

fix(guidelines): add pseudo element example

d102c68

mcoker approved these changes Aug 29, 2025

View reviewed changes

fix(links): update broken links

779d911

mcoker approved these changes Aug 29, 2025

View reviewed changes

mcoker merged commit d128e5c into patternfly:main Aug 29, 2025
4 checks passed

patternfly-build added the released on @prerelease label Sep 3, 2025

This was referenced Jul 22, 2026

The automated release is failing 🚨 #8519

Closed

The automated release is failing 🚨 #8533

Closed

Conversation

nicolethoen commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

patternfly-build commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

srambach commented Jul 2, 2025

Uh oh!

nicolethoen commented Jul 2, 2025

Uh oh!

Uh oh!

mcoker commented Jul 29, 2025

Uh oh!

srambach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

srambach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

nicolethoen commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mcoker left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

patternfly-build commented Sep 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

nicolethoen commented Jun 30, 2025 •

edited

Loading

patternfly-build commented Jun 30, 2025 •

edited

Loading

nicolethoen commented Aug 29, 2025 •

edited

Loading