patternfly / patternfly/patternfly-react
Update contribution guide to include guidelines for deprecated components
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 862
- Forks
- 392
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 9
Description
Describe the enhancement or change
What it means for a component to be deprecated is currently unclear to our consumers.
Our contribution guidelines should explain what a component being deprecated entails, including how long it will still be available and how it impacts what work will be done on it going forward.
Jira Issue: PF-123
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 locating the repository's contribution guide and review its existing component-lifecycle guidance. Update the guide to define what deprecated means, state how long deprecated components remain available, and explain how deprecation affects future work; done means these points are clear to consumers and the documentation review passes.
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
- 35/100