Skip to content

Commit d852579

Browse files
committed
update guidance for ca rules guidance
1 parent eee45c1 commit d852579

2 files changed

Lines changed: 14 additions & 9 deletions

File tree

.openpublishing.redirection.json

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@
1111
"source_path": "Contribute/light-workflow.md",
1212
"redirect_url": "/"
1313
},
14+
{
15+
"source_path": "Contribute/content/dotnet/dotnet-contribute-code-analysis.md",
16+
"redirect_url": "/contribute/dotnet/code-analysis-rules",
17+
"redirect_document_id": true
18+
},
1419
{
1520
"source_path": "Contribute/dotnet-contribute-process.md",
1621
"redirect_url": "/contribute/dotnet/dotnet-contribute"
@@ -237,11 +242,11 @@
237242
"source_path": "ai-navigator/index.yml",
238243
"redirect_url": "/contribute/",
239244
"redirect_document_id": false
240-
},
245+
},
241246
{
242247
"source_path": "Contribute/content/architecture-center/solution-idea-templates.md",
243248
"redirect_url": "/contribute/content/architecture-center/aac-contribute",
244249
"redirect_document_id": false
245250
}
246251
]
247-
}
252+
}

Contribute/content/dotnet/dotnet-contribute-code-analysis.md renamed to Contribute/content/dotnet/code-analysis-rules.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
11
---
2-
title: Contribute docs for .NET code analysis rules to the .NET docs repository
2+
title: Contribute docs for .NET code analysis rules
33
description: This article describes the process for contributing to the articles and code samples for .NET code analysis rules in the .NET docs repository.
44
author: mavasani
55
ms.author: mavasani
66
ms.topic: contributor-guide
77
ms.service: learn
88
ms.custom: external-contributor-guide
9-
ms.date: 06/17/2025
9+
ms.date: 03/17/2026
1010
---
11-
# Contribute docs for .NET code analysis rules to the .NET docs repository
11+
# Contribute docs for .NET code analysis rules
1212

13-
.NET compiler platform (Roslyn) analyzers inspect your C# or Visual Basic code for code quality and code style issues. Starting in .NET 5.0, these analyzers are [included with the .NET SDK](/dotnet/fundamentals/code-analysis/overview).
13+
.NET compiler platform (Roslyn) analyzers inspect your C# or Visual Basic code for code quality and code style issues. These analyzers are [included with the .NET SDK](/dotnet/fundamentals/code-analysis/overview).
1414

1515
- [Code quality analysis ("CAxxxx" rules)](/dotnet/fundamentals/code-analysis/overview#code-quality-analysis):
16-
- Implemented [here](https://github.com/dotnet/roslyn-analyzers/tree/main/src/NetAnalyzers) in `dotnet/roslyn-analyzers` repo.
16+
- Implemented in the [dotnet/sdk](https://github.com/dotnet/sdk/tree/main/src/Microsoft.CodeAnalysis.NetAnalyzers) repo (previously implemented in `dotnet/roslyn-analyzers` repo).
1717
- Documented [here](https://github.com/dotnet/docs/blob/main/docs/fundamentals/code-analysis/quality-rules) in the `dotnet/docs` repo. See [Contribute docs for 'CAxxxx' rules](#contribute-docs-for-caxxxx-rules).
1818
- [Code style analysis ("IDExxxx" rules)](/dotnet/fundamentals/code-analysis/overview#code-style-analysis):
19-
- Implemented [here](https://github.com/dotnet/roslyn/tree/main/src/Analyzers) in `dotnet/roslyn` repo.
19+
- Implemented in the [dotnet/roslyn](https://github.com/dotnet/roslyn/tree/main/src/Analyzers) repo.
2020
- Documented [here](https://github.com/dotnet/docs/blob/main/docs/fundamentals/code-analysis/style-rules) in the `dotnet/docs` repo. See [Contribute docs for 'IDExxxx' rules](#contribute-docs-for-idexxxx-rules).
2121

2222
## Contribute docs for 'CAxxxx' rules
2323

2424
Please follow the following steps to contribute documentation for code quality analysis rules to the [dotnet/docs](https://github.com/dotnet/docs) repo:
2525

26-
1. Determine `Rule ID` and `Category`: Ensure that you know the 'CAxxxx' rule ID and category for the rule to be documented. This means either your CA analyzer has been merged into [dotnet/roslyn-analyzers](https://github.com/dotnet/roslyn-analyzers) repo or you have an open PR with an approved ID and category that has been assigned to the rule.
26+
1. Determine `Rule ID` and `Category`: Ensure that you know the 'CAxxxx' rule ID and category for the rule to be documented. This means either your CA analyzer has been merged into the [dotnet/sdk](https://github.com/dotnet/sdk) repo or you have an open PR with an approved ID and category that has been assigned to the rule.
2727
2. Add rule doc:
2828
1. Clone an existing CA rule file under [root](https://github.com/dotnet/docs/blob/main/docs/fundamentals/code-analysis/quality-rules) folder, say `ca1000.md`, and rename it.
2929
2. Update the content of the file appropriately.

0 commit comments

Comments
 (0)