patternfly / patternfly/patternfly-react

Update contribution guide to include guidelines for deprecated components

Đang mở
#9,460 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

PF Team Pinned
Ngôn ngữ chính
TypeScript
Star
862
Fork
392
Merge trung bình
4 ngày 8 giờ
Pull request đã merge (30 ngày)
9

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách tìm hướng dẫn đóng góp của repository và xem lại hướng dẫn hiện có về vòng đời component. Cập nhật hướng dẫn để định nghĩa deprecated nghĩa là gì, nêu rõ các component deprecated tiếp tục khả dụng trong bao lâu và giải thích deprecation ảnh hưởng thế nào đến công việc trong tương lai; được xem là hoàn tất khi các điểm này rõ ràng đối với consumer và phần review tài liệu được thông qua.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.