patternfly / patternfly/patternfly-org

Clarify information about the standard PF bundle

Open
#2,722 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Content PF Team
Dominant language
JavaScript
Stars
74
Forks
147
Avg merge
4d 11h
Merged PRs (30d)
2

Description

Probably worth a few lines in the Getting Started -> Developers to clarify what is NOT included.
Getting started -> About mentions utilities but does not say how to use them or what to import


Jira Issue: PF-358

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the Getting Started → Developers and Getting Started → About sections mentioned in the issue. Clarify what the standard PF bundle excludes, how the utilities are used, and what should be imported; done means those sections explain the bundle contents and utility imports without ambiguity.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.