PowerShell / PowerShell/PSScriptAnalyzer

Add suggestion to read About_TOPIC files to Script Analyzer rules

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

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

Area - Documentation Area - Rules Issue - Enhancement
Ngôn ngữ chính
C#
Star
2.2k
Fork
414
Merge trung bình
13 giờ 1 phút
Pull request đã merge (30 ngày)
2

Mô tả

When you have a Rule run for example the PSUseOutputTypeCorrectly I would suggest adding in information to the rule Output to the user to check any possible corresponding About_help Topic for information on how to mitigate the rule being flagged.

@juneb - What do you think to this idea?

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 việc xem xét đầu ra của quy tắc PSUseOutputTypeCorrectly và hướng dẫn trợ giúp About_TOPIC tương ứng. Xác định cách các thông báo quy tắc áp dụng được có thể hướng người dùng đến thông tin giảm thiểu, đồng thời xem xét các quy tắc Script Analyzer khác có thể có các topics tương ứng. Công việc được xem là hoàn tất khi đầu ra của các quy tắc liên quan luôn trỏ người dùng đến hướng dẫn phù hợp.

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

Đánh giá

Công nghệ
powershell
Lĩnh vực
devtools
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
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.