patternfly / patternfly/patternfly-react

Update contribution guide to include guidelines for deprecated components

オープン
#9,460 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

PF Team Pinned
主要言語
TypeScript
スター
862
フォーク
392
平均マージ
4日 8時間
マージ済み PR(30日)
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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まずリポジトリの contribution guide を見つけ、既存の component-lifecycle に関するガイダンスを確認します。deprecated の意味、deprecated なコンポーネントが利用可能な状態で残る期間、deprecation が今後の作業に与える影響を guide に定義・明記します。これらの点が consumer にとって明確になり、ドキュメントのレビューに合格すれば完了です。

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。