dennisdoomen / CSharpGuidelines

A set of coding guidelines for C# 9.0, design principles and layout rules for improving the overall quality of your code development.
https://www.csharpcodingguidelines.com
Other
746 stars 271 forks source link

Thoughts to reorganize rules in Performance chapter #246

Open bkoelman opened 2 years ago

bkoelman commented 2 years ago

Not all rules in this chapter are about performance. Some are about multi-threading and async/await:

On the other hand, the next rules concern performance, but are in a different chapter:

The next rules affect async/await, but are in a different chapter:

I'm thinking we should have a chapter on Performance and one on Async/Threading. But of course, that would change the IDs of existing rules, which is problematic for https://www.nuget.org/packages/CSharpGuidelinesAnalyzer/, because developers have existing suppressions by rule ID in their codebases, which will break.

dennisdoomen commented 2 years ago

As discussed f2f, it seems that the impact on existing consumers of your analyzer would have to reconfigure their suppressions. It might be better to postpone that until the next major version.