Skip to content

Commit a39fb2a

Browse files
authored
Merge pull request #1175 from gewarren/ca-rules-guidance
Update guidance for CA rules docs
2 parents eee45c1 + 7dbb327 commit a39fb2a

4 files changed

Lines changed: 25 additions & 22 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/content/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/TOC.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@
102102
- name: Pull request review process
103103
href: dotnet/dotnet-pr-review.md
104104
- name: Code analysis docs
105-
href: dotnet/dotnet-contribute-code-analysis.md
105+
href: dotnet/code-analysis-rules.md
106106
- name: Patterns and Practices (AAC, WAF, CAF)
107107
href: architecture-center/aac-contribute.md
108108
- name: PowerShell-Docs

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

Lines changed: 8 additions & 8 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
5-
ms.author: mavasani
5+
ms.author: gewarren
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.

Contribute/index.yml

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
### YamlMime:Marketing
2-
### YamlMime:Marketing
32
title: 'Experts Hub'
43
metadata:
5-
title: 'Experts Hub: Share what you know. Shape whats next.'
4+
title: "Experts Hub: Share what you know. Shape what's next."
65
description: 'Share your knowledge with the world as a Microsoft expert!'
76
sections:
87
# hero with background image
@@ -16,7 +15,7 @@ sections:
1615
src: media/experts-hub-long-format-400.png
1716
# top navigation links
1817
- componentType: navigation
19-
size: large
18+
size: large
2019
alignment: center
2120
blocks:
2221
- componentType: icon-link
@@ -39,7 +38,7 @@ sections:
3938
questions:
4039
- question: Overview of this section
4140
answer: |
42-
This section highlights highinterest topics your audience is already searching for and talking about. Think of these as prime opportunities to create content that stands out and attracts learners who are actively looking for guidance.
41+
This section highlights high-interest topics your audience is already searching for and talking about. Think of these as prime opportunities to create content that stands out and attracts learners who are actively looking for guidance.
4342
4443
If a topic aligns with your expertise, jump in and turn it into content that showcases your voice and point of view. You might:
4544
@@ -53,7 +52,6 @@ sections:
5352
answer: |
5453
Grow your reputation on Microsoft Q&A by providing expert insights, clarification, and solutions on these trending topics:
5554
56-
- There's interest in understanding the differences between [Developer Command Prompt and Developer PowerShell in Visual Studio](https://learn.microsoft.com/answers/questions/5722678/what-are-the-different-between-developer-command-p).
5755
- Help Azure users [understand error codes](https://learn.microsoft.com/answers/questions/5562339/error-code-5000225-message-this-tenant-has-been-bl) related to managing [tenant lifecycles in Microsoft Entra](https://learn.microsoft.com/entra/fundamentals/inaccessible-tenant).
5856
- Learners want to understand how to use agents created from templates in Copilot Studio, such as the [Customer Insight template agent](https://learn.microsoft.com/answers/questions/5527396/an-agent-created-through-co-pilot-studio-is-not-ab).
5957
- question: 'Updates and tools for AI builders in Microsoft Foundry'
@@ -67,7 +65,7 @@ sections:
6765
- Developer audiences are interested in building and remotely hosting MCP servers. [This episode](https://learn.microsoft.com/shows/azure-friday/host-remote-mcp-servers-on-azure-functions), led by Scott Hanselman and Lily Ma, demonstrates how to remotely host MCP servers on Azure Functions with official MCP SDKs.
6866
- Explore a [deep dive into the AKS MCP Server & Agentic CLI](https://www.youtube.com/watch?v=tEPfxO1FEMk) in January's AKS community call.
6967
- As more audiences build AI agents, they're looking to improve cost efficiency on Azure. [This learning path on maximizing AI agent ROI](https://learn.microsoft.com/training/paths/maximize-cost-efficiency-ai-agents/) offers strategies for cost-conscious decisions, ROI forecasting, and scalable architectures to optimize investments on Azure.
70-
- question: AI for all levels of .NET developers
68+
- question: AI for all levels of .NET developers
7169
answer: |
7270
Help .NET developers across multiple skill levels understand the foundations and opportunities for leveraging AI in their applications.
7371
- [Hands-on course](https://github.com/microsoft/Generative-AI-for-beginners-dotnet) and [accompanying video series](https://www.youtube.com/playlist?list=PLdo4fOcmZ0oUkPkWy9EtmBvFAjfp4ZHnx) on Generative AI fundamentals with .NET.
@@ -82,7 +80,7 @@ sections:
8280
alt: A GitHub Copilot chat interaction with the Microsoft Learn MCP Server
8381
componentType: image
8482
- title: Content creation resources for the Microsoft Learn MCP Server
85-
summary: A set of ready-to-use assets to help you accurately present, demo, and share the Microsoft Learn MCP Server with your audience.
83+
summary: A set of ready-to-use assets to help you accurately present, demo, and share the Microsoft Learn MCP Server with your audience.
8684
componentType: text
8785
links:
8886
- componentType: link
@@ -184,7 +182,7 @@ sections:
184182
title: Impactful opportunities happening now
185183
blocks:
186184
- componentType: summary-card
187-
title: Contribute to awesome-azd
185+
title: Contribute to awesome-azd
188186
summary: Share templates for using the Azure Developer CLI (azd) by contributing to the awesome-azd collection.
189187
url: https://github.com/azure/awesome-azd
190188
- componentType: summary-card
@@ -193,7 +191,7 @@ sections:
193191
url: https://github.com/github/awesome-copilot
194192
- componentType: summary-card
195193
title: Join the Azure AI Foundry Discord community
196-
summary: Join the Azure AI Foundry community to share your knowledge and connect with other AI experts and learners.
194+
summary: Join the Azure AI Foundry community to share your knowledge and connect with other AI experts and learners.
197195
url: https://discord.com/invite/microsoftfoundry
198196
- componentType: summary-card
199197
title: Agent Creators
@@ -260,7 +258,7 @@ sections:
260258
title: Connect with us
261259
links:
262260
- componentType: social-link
263-
url: https://twitter.com/MicrosoftLearn
261+
url: https://twitter.com/MicrosoftLearn
264262
destination: twitter
265263
- componentType: social-link
266264
url: https://www.linkedin.com/showcase/microsoftlearn/
@@ -269,5 +267,5 @@ sections:
269267
url: https://www.tiktok.com/@microsoftlearn
270268
destination: website
271269
- componentType: social-link
272-
url: https://aka.ms/MicrosoftLearnNewsletter
270+
url: https://aka.ms/MicrosoftLearnNewsletter
273271
destination: website

0 commit comments

Comments
 (0)