PowerShell / PowerShell/PSScriptAnalyzer
Definitions for Information, Warning, and Error Severities
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- C#
- Estrelas
- 2.2k
- Forks
- 414
- Merge médio
- 13h 1min
- PRs com merge (30d)
- 2
Descrição
In the code comments for the RuleSeverity enum, a warning does not follow PowerShell's "recommended" guidelines and Errors do not conform to PowerShell's "required" guidelines. Information rules are "recommended by PowerShell best practice".
I just posted #466 and now that I am thinking about it, I am not sure what the specific criteria is that would differentiate Warnings from Errors. For my team, at my company, we cannot have any hard coded passwords in a script, so this would definitely be an Error. However, that might not be the case for everyone everywhere.
The definitions of Warning and Error severity should be clearly defined in the documentation. I have some ideas and opinions here, as I am sure everyone in the PS community does. Would it make sense to use https://github.com/PoshCode/PowerShellPracticeAndStyle as a starting point for best practices and guidelines?
I am also wondering if it would make sense to have the ability to override severity levels for built in rules.
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece pelos comentários do enum RuleSeverity e compare a redação atual deles com as orientações do PowerShellPracticeAndStyle vinculadas na issue. Defina e documente critérios que distingam as severidades Information, Warning e Error e esclareça se as substituições de severidade integradas estão no escopo.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- powershell
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Precisa de esclarecimento
- Facilidade para iniciantes
- 25/100