patternfly / patternfly/patternfly-react
chore: clean up exported helpers
Open
Nobody has claimed this yet.
Breaking change :boom:
- Dominant language
- TypeScript
- Stars
- 862
- Forks
- 392
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 9
Description
Some of the exported helpers should only be used internally to PF.
- Let's reassess what we export
- Find a way to document functionality on the website that should be exported.
cc @evwilkin
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inventorying the exported helpers in PatternFly React and reviewing the website documentation areas that describe functionality. Clarify which helpers are intended for internal use versus public use, then update the exports and documentation accordingly. Done means the public export surface and website guidance agree.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation, frontend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100