Repository navigation
docs: adds missing guidance for public api analyzers updates - #8035
Merged
Vincent Biret (baywet) merged 3 commits intoSep 3, 2026
Merged
Conversation
Vincent Biret (baywet)
requested review from
SergeyMenshykh,
Tao Chen (TaoChenOSU),
chetantoshniwal,
Eduard van Valkenburg (eavanvalkenburg),
Giles Odigwe (giles17),
Evan Mattson (moonbox3),
Peter Ibekwe (peibekwe),
Roger Barreto (rogerbarreto) and
westey (westey-m)
as code owners
September 3, 2026 14:29
Vincent Biret (baywet)
temporarily deployed
to
github-app-auth
September 3, 2026 14:29 — with 
GitHub Actions
Inactive
GitHub Actions
Inactive
Vincent Biret (baywet)
temporarily deployed
to
github-app-auth
September 3, 2026 14:29 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
Vincent Biret (baywet)
temporarily deployed
to
github-app-auth
September 3, 2026 14:29 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
agent-framework-automation
Bot
added
the
documentation
Vincent Biret (baywet)
enabled auto-merge
September 3, 2026 14:29
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The guidance incorrectly treats RS0017 as fixable through the RS0016 baseline-update workflow.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds troubleshooting guidance for .NET public API analyzer diagnostics.
Changes:
- Documents analyzer code-fix usage.
- Adds a targeted
dotnet formatcommand.
File summaries
| File | Description |
|---|---|
CONTRIBUTING.md |
Adds public API baseline troubleshooting guidance. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Balanced
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: baywet <[email protected]>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The removal guidance conflicts with unshipped API handling and the existing promotion script.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Balanced
Signed-off-by: Vincent Biret <[email protected]>
Vincent Biret (baywet)
temporarily deployed
to
github-app-auth
September 3, 2026 14:46 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
The documented RS0017 code fix and command do not exist or resolve the diagnostic.
Review details
Suppressed comments (1)
CONTRIBUTING.md:124
RS0017hasCodeFix: Falsein the analyzer metadata, so neither a “corresponding code fix” nordotnet format --diagnostics RS0017can create the*REMOVED*entry. The command will leave contributors with the warning unresolved; document the required manual baseline edit instead.
- `RS0017` reports that a declared public API was deleted. Restore the API if the deletion was accidental; otherwise, record the removed signature in the package's `PublicAPI.Unshipped.txt` file with the `*REMOVED*` prefix by using the corresponding code fix, or the following dotnet format script:
```powershell
dotnet format .\dotnet\agent-framework-dotnet.slnx analyzers --diagnostics RS0017
- **Files reviewed:** 1/1 changed files
- **Comments generated:** 0 new
- **Review effort level:** Balanced
</details>
westey (westey-m)
approved these changes
Sep 3, 2026
Vincent Biret (baywet)
deleted the
docs/public-analyzers-troubleshooting
branch
September 17, 2026 14:29
This branch was previously deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.