PowerShell / PowerShell/PSScriptAnalyzer

New function: Show-RuleHelp

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

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

Issue - Discussion 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ả

I have a function to submit, Show-RuleHelp, which opens the .md file of help for each rule. Before I do a PR, I want to know if you're interested in including it and, if so, how?

-- Add the script containing the function to ScriptsToProcess
-- Add the function to PSScriptAnalyzer.psm1 + FunctionsToExport in the psd1

You can see the code at https://github.com/juneb/Development/blob/master/Show-RuleHelp.ps1.

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 triển khai Show-RuleHelp.ps1 được liên kết, sau đó kiểm tra PSScriptAnalyzer.psm1 và các mục trong module manifest được nêu trong issue. Xác định xem hàm có thuộc ScriptsToProcess và có nên được export hay không; công việc được xem là hoàn tất khi đã quyết định cách đưa vào và xác thực hành vi của module kết quả.

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
cli, documentation
Loại issue
Tính năng
Độ 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
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.