PowerShell / PowerShell/PSScriptAnalyzer

Improve rule suppression documentation

Đang mở
#697 0 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 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ả

Existing documentation doesn't provide any information regarding rule-wise behavior of code suppression.

For example, PSSA cannot suppress PSAvoidUsingUserNameAndPassWordParams violations based on given rulesuppressionid.

    Configuration Foo
    {             
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordParams", "UserName", Scope="Function")]
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingUserNameAndPassWordPara", "EncryptedPassword", Scope="Function")]
        param (
            [Parameter(Mandatory)]
            [String]$UserName,

            [Parameter(Mandatory)]
            [String]$Password
        )

    }

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

Issue không nêu tệp tài liệu hay bài kiểm thử nào. Hãy bắt đầu bằng cách tìm tài liệu hiện có về việc suppress rule và xem lại cách PSSA xử lý ví dụ SuppressMessageAttribute được nêu, bao gồm các giá trị rulesuppressionid. Công việc được xem là hoàn tất khi tài liệu giải thích hành vi suppress theo từng rule và bao quát ví dụ PSavoidUsingUserNameAndPassWordParams.

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
documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 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
45/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.