Skip to content

File renames in analyzers#53805

Merged
krwq merged 2 commits intodotnet:mainfrom
krwq:docs-cleanup-renames
Apr 14, 2026
Merged

File renames in analyzers#53805
krwq merged 2 commits intodotnet:mainfrom
krwq:docs-cleanup-renames

Conversation

@krwq
Copy link
Copy Markdown
Member

@krwq krwq commented Apr 10, 2026

Some renames because I now own this and have OCD

@krwq krwq requested a review from jeffhandley April 10, 2026 10:02
@krwq krwq requested a review from a team as a code owner April 10, 2026 10:02
Copilot AI review requested due to automatic review settings April 10, 2026 10:02
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the NetAnalyzers documentation set by renaming the analyzer configuration doc to a kebab-case filename and updating in-repo references/packaging accordingly, while also adding several new documentation pages and assets under src/Microsoft.CodeAnalysis.NetAnalyzers/docs.

Changes:

  • Rename/update references to the analyzer configuration documentation file (analyzer-configuration.md) in source comments and NuGet packing.
  • Update existing docs to point at the renamed configuration doc.
  • Add multiple new documentation pages (performance workflow, getting-started, contribution guidelines, FxCop porting docs) and related assets (CSV inventory, PNG).

Reviewed changes

Copilot reviewed 4 out of 15 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/Microsoft.CodeAnalysis.NetAnalyzers/src/Utilities/FlowAnalysis/Options/EditorConfigOptionNames_FlowAnalysis.cs Updates the “keep in sync with docs” comment to the new doc filename.
src/Microsoft.CodeAnalysis.NetAnalyzers/src/Utilities/Compiler/Options/EditorConfigOptionNames.cs Updates the “keep in sync with docs” comment to the new doc filename.
src/Microsoft.CodeAnalysis.NetAnalyzers/src/Microsoft.CodeAnalysis.NetAnalyzers.Package.csproj Packs the renamed configuration doc and updates the configuration filename property.
src/Microsoft.CodeAnalysis.NetAnalyzers/docs/writing-dataflow-analysis-based-analyzers.md Updates links to analyzer configuration documentation.
src/Microsoft.CodeAnalysis.NetAnalyzers/docs/performance.md Adds new documentation describing a proposed analyzer performance measurement workflow.
src/Microsoft.CodeAnalysis.NetAnalyzers/docs/netcore-getting-started.md Adds new getting-started guidance for analyzer development.
src/Microsoft.CodeAnalysis.NetAnalyzers/docs/make-static.png Adds a new image asset.
src/Microsoft.CodeAnalysis.NetAnalyzers/docs/guidelines-for-new-rules.md Adds contribution guidelines for proposing/adding new CA rules.
src/Microsoft.CodeAnalysis.NetAnalyzers/docs/FxCopPort/rules-inventory.csv Adds a rules inventory CSV for FxCop porting/tracking.
src/Microsoft.CodeAnalysis.NetAnalyzers/docs/FxCopPort/proposed-fxcop-rule-changes-in-roslyn.md Adds documentation describing proposed deviations from FxCop behavior.
src/Microsoft.CodeAnalysis.NetAnalyzers/docs/FxCopPort/porting-fxcop-rules-to-roslyn.md Adds background/design doc for porting rules from FxCop to Roslyn analyzers.
src/Microsoft.CodeAnalysis.NetAnalyzers/docs/documenting-your-analyzers.md Adds documentation guidance for writing analyzer reference docs.
src/Microsoft.CodeAnalysis.NetAnalyzers/docs/analyzer-reference-page-template.md Adds a template for analyzer reference pages.
src/Microsoft.CodeAnalysis.NetAnalyzers/docs/analyzer-configuration.md Adds the renamed analyzer configuration documentation file/content.
Comments suppressed due to low confidence (1)

src/Microsoft.CodeAnalysis.NetAnalyzers/docs/writing-dataflow-analysis-based-analyzers.md:152

  • These links point to the v2.9.7 tag, but the doc filename was changed to analyzer-configuration.md. Unless that tag also contains the renamed file, these URLs will 404. Consider linking to main for the configuration doc, or keep the old filename for tagged URLs.

Copy link
Copy Markdown
Member

@jeffhandley jeffhandley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. Much nicer. 😃

@krwq krwq merged commit 3b6aee1 into dotnet:main Apr 14, 2026
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants