PowerShell / PowerShell/PSScriptAnalyzer
Properly document PSSA2
Đang mở
Chưa có ai nhận issue này.
Consider - 2.0
- 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ả
PSSA2 should have full documentation. This includes:
- Descriptive code comments that can be used to provide API documentation for consumers
- Documentation of all rules
- Documentation of configuration and how to configure and run for users
- Documentation on rule suppression
- Documentation on hosting
- Documentation on implementing a rule in both .NET and PS script
- Documentation on the project's architecture
- A full README on how to build, run and contribute
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- 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 kiểm kê các quy tắc, cấu hình và hành vi suppression của dự án, mô hình hosting, kiến trúc và README hiện có. Xem xét các đường dẫn triển khai quy tắc .NET và PowerShell để xác định các chú thích và ví dụ về API cần được ghi tài liệu. Công việc được hoàn thành khi tài liệu về README, thiết lập cho người dùng và contributor, tham chiếu quy tắc, cấu hình, suppression, hosting, kiến trúc và việc tạo quy tắc đã đầy đủ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- csharp, powershell
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 20/100