patternfly / patternfly/patternfly-react
Update contribution guide to include guidelines for deprecated components
未关闭
还没有人认领这个 Issue。
PF Team
Pinned
- 主要语言
- TypeScript
- 星标
- 862
- 派生
- 392
- 平均合并
- 4 天 8 小时
- 30 天内合并 PR
- 9
描述
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
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
首先定位 repository 的贡献指南，并查看其中现有的组件生命周期指导。更新该指南，定义 deprecated 的含义，说明 deprecated 组件会继续可用多长时间，并解释 deprecation 会如何影响后续工作；当这些要点对使用者清晰明确且文档审查通过时，即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100