The new `docs\Rules\README.md` format causes merge issues
Mantenedores costumam responder em até 1 dia
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 48/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Ativa
- Stack de tecnologia
- markdown
- Domínio
- documentation
Direção de pesquisa
Start with docs/Rules/README.md and compare the format introduced by PR2196 with the conflicts reported in PRs #2186 and #2183. Determine a maintainable reference or index arrangement; done means adding an alphabetized rule does not require renumbering unrelated entries or create merge conflicts.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
(this concerns contribution -documentation- issue)
As far as I can tell, the new docs\Rules\README.md setup (PR2196) will cause a merge conflict with every new rule added to the analyzer repo like: #2186 and #2183.
The new format change:
- Update rules index (docs/Rules/README.md) to a new “Default state” model and add link references for maintainability
Which results in a table like:
| Rule | Severity | Default state | Configurable |
| -------------------------------------------------- | ----------- | :------------: | :----------: |
| [AlignAssignmentStatement][02] | Warning | Disabled | Yes |
| [AvoidAssignmentToAutomaticVariable][03] | Warning | Always enabled | |
| [AvoidDefaultValueForMandatoryParameter][04] | Warning | Always enabled | |
...
And a reference list like:
<!-- link references -->
[01]: ../using-scriptanalyzer.md#suppressing-rules
[02]: AlignAssignmentStatement.md
[03]: AvoidAssignmentToAutomaticVariable.md
[04]: AvoidDefaultValueForMandatoryParameter.md
[05]: AvoidDefaultValueSwitchParameter.md
...
Might be a beter practice for a static README.md, it isn't for a dynamic README.md that needs to be updated with each new rule. The difficulty is because the rule list is alphabetically and inserting a new rule document to the list requires to update all following rules and reference links (that are not related to the new rule PR). Doing so, is in fact rather difficult to maintain and error prone.
A workaround might simply using the next available reference number (e.g. [81]) but that would then appear somewhere in the middle of the list (depending on the rule name) with is quite inconsistent and doesn't add much value to the "maintainability".
- Linguagem predominante
- C#
- Estrelas
- 2.2k
- Forks
- 422
- Merge médio
- 2h 23min
- PRs com merge (30d)
- 25
Preparar o ambiente
Inicia o contêiner de desenvolvimento do projeto no navegador, com a sua própria conta do GitHub.
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o 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.
Mais de PowerShell/PSScriptAnalyzer
-
Up-for-Grabs
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 78/100
PowerShell/PSScriptAnalyzer#2213 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 4/5 1-2 dias Facilidade para iniciantes 18/100
PowerShell/PSScriptAnalyzer#2302 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 55/100
PowerShell/PSScriptAnalyzer#2300 ·
Mantenedores costumam responder em até 1 dia
-
Invoke-ScriptAnalyzer fails intermittently with NullReferenceException in CommandInfo.ResolveParameter (ProvideCommentHelp / AvoidReservedCharInCmdlet race on Export-ModuleMember)Talvez já em andamento @jessehouwing assumiu há 89 dias. AbertaIssue - Bug
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 52/100
PowerShell/PSScriptAnalyzer#2229 · 6 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 32/100
PowerShell/PSScriptAnalyzer#2222 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
Todas as issues de PowerShell/PSScriptAnalyzer
Issues semelhantes
-
kind/bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
unoplatform/uno#26555 ·
Mantenedores costumam responder em até 1 dia
-
chore project-system small
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
vikramlearning/blazorbootstrap#1388 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
GamaEdtech/gamatrain-back#977 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
jhaizhou-ops/S2Arm#1396 · 1 comentário ·
Mantenedores costumam responder em até 1 dia