The new `docs\Rules\README.md` format causes merge issues
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 48/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- markdown
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
(this concerns contribution -documentation- issue)
As far as I can tell, the new docs\Rules\README.md setup (PR2196) will cause an 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 a beter practice for a static README.md, 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".
- 主要语言
- C#
- 星标
- 2.2k
- 派生
- 415
- 平均合并
- 13 小时 1 分钟
- 30 天内合并 PR
- 2
环境准备
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
PowerShell/PSScriptAnalyzer 的其他 Issue
-
Up-for-Grabs
难度 1/5 1-3 小时 新手友好度 78/100
PowerShell/PSScriptAnalyzer#2213 · 2 条评论 ·
-
难度 3/5 1-2 天 新手友好度 55/100
PowerShell/PSScriptAnalyzer#2219 ·
-
难度 3/5 1-2 天 新手友好度 72/100
PowerShell/PSScriptAnalyzer#2218 ·
-
难度 3/5 1-2 天 新手友好度 72/100
PowerShell/PSScriptAnalyzer#2217 · 1 条评论 ·
-
PSUseConsistentIndentation double-indents attribute bodies that open a scriptblock (`[Attr({ … })]`)未关闭
难度 3/5 1-2 天 新手友好度 70/100
PowerShell/PSScriptAnalyzer#2216 · 2 条评论 · 1 个 reaction ·
查看 PowerShell/PSScriptAnalyzer 的全部 Issue
相似的 Issue
-
:watch: Not Triaged dotnet-target-version
难度 1/5 1 小时以内 新手友好度 85/100
维护者通常 1 天内回复
-
copilot documentation
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 2 天内回复
-
untriaged
难度 2/5 1-3 小时 新手友好度 86/100
dotnet/dotnet-api-docs#13124 ·
维护者通常 1 天内回复
-
agentic-workflows
难度 2/5 1-3 小时 新手友好度 74/100
维护者通常 1 天内回复
-
type:bug
难度 2/5 1-3 小时 新手友好度 82/100
BHoM/MidasCivil_Toolkit#441 ·