Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Why ReleaseTrackingAnalyzers? #7467

Open
AArnott opened this issue Nov 5, 2024 · 0 comments
Open

Why ReleaseTrackingAnalyzers? #7467

AArnott opened this issue Nov 5, 2024 · 0 comments

Comments

@AArnott
Copy link
Contributor

AArnott commented Nov 5, 2024

The doc at https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.Analyzers/ReleaseTrackingAnalyzers.Help.md does a fairly thorough job of describing the .md files that the new analyzer wants to see and the process of maintaining those files.

But why?

The document doesn't explain what those two new files do for anyone.

I tried including those .md files in my public docfx documentation using include syntax but the apparently mandated ; prefixed lines at the top of each file appear in the rendered markdown which is tacky.

So I can't think of any reason to maintain these files. What good are they?

AArnott added a commit to AArnott/Nerdbank.MessagePack that referenced this issue Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant