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

Document missing CAxxxx rules #27885

Merged
merged 18 commits into from
Jan 25, 2022
Merged

Conversation

Youssef1313
Copy link
Member

@Youssef1313 Youssef1313 commented Jan 19, 2022

  • CA1419
  • CA1727
  • CA1842
  • CA1843
  • CA1848
  • CA2017
  • CA2253
  • CA2254
  • CA2256
  • CA2257
  • CA2258

Fixes #23900
Fixes #27857

Not the best documentation one can write, but at least there are pages that readers can submit feedback about.

https://github.com/dotnet/roslyn-analyzers/blob/main/src/NetAnalyzers/Microsoft.CodeAnalysis.NetAnalyzers.sarif for reference

Copy link
Member Author

@Youssef1313 Youssef1313 left a comment

Choose a reason for hiding this comment

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

@maryamariyan Would you be able to review CA1727, CA1848, CA2017, CA2253, and CA2254?

For CA1727, I feel I'm not adding any useful information.
For CA1848, I'm almost copying from ASP.NET Core docs.


@jkoritzinsky Would you be able to review CA2256, CA2257, and CA2258?


Also @gewarren for review.

@Youssef1313 Youssef1313 marked this pull request as ready for review January 19, 2022 14:24
@Youssef1313 Youssef1313 requested review from gewarren and a team as code owners January 19, 2022 14:24
@maryamariyan
Copy link
Member

@maryamariyan Would you be able to review CA1727, CA1848, CA2017, CA2253, and CA2254?

Looking. FYI perhaps you could use the content in this PR to help populate information for the above 5 diagnostics: https://github.com/dotnet/roslyn-analyzers/pull/5244/files

Copy link
Member

@maryamariyan maryamariyan left a comment

Choose a reason for hiding this comment

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

CA1727, CA1848, CA2017, CA2253, and CA2254 changes LGTM.

Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

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

Thanks @Youssef1313!

docs/fundamentals/code-analysis/quality-rules/ca1727.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/quality-rules/ca1843.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/quality-rules/ca1848.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/quality-rules/ca1848.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/quality-rules/ca2017.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/quality-rules/ca2258.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/quality-rules/index.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/quality-rules/index.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/quality-rules/index.md Outdated Show resolved Hide resolved
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@Youssef1313
Copy link
Member Author

@gewarren Is this ready to merge?

@gewarren gewarren merged commit a4aecc8 into dotnet:main Jan 25, 2022
@Youssef1313 Youssef1313 deleted the missing-ca-docs branch January 25, 2022 17:01
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

Successfully merging this pull request may close these issues.

CA2254 404 Not Found Tracking issue for missing documentation of .NET6 CAxxxx rules
3 participants