search

Softeq / dotnet-guidelines

A set of coding guidelines for C#, design principles, and layout rules.
Other
13 stars 1 forks source link

What 'recommended guidelines' means? #1

Open oleg-zaitsev opened 4 years ago

oleg-zaitsev commented 4 years ago

Now it is not clear what 'recommended guidelines' (severity = 2) stands for. Who makes a decision to skip or to apply the rule? From my perspective, we can change the wording to 'The rule must be applied always except the cases when there is a significant reason not to do this' and give an example of using Async-postfix with controller's actions or Mediator's handlers. We also need to specify who is responsible for making such decisions (is it a project team or ream/tech lead).

eabliazimov commented 4 years ago

agree with @dekroll, @smolyakoff, @ee-jee, @eugene-paseka-softeq what do you think?

oleg-zaitsev commented 4 years ago

it's been a while since we discussed this topic last time, I suggest reviewing optional rules and either increasing their severity to 1 or removing at all. This will decrease number of rules that must be maintained and make it simpler to follow the guideline.

@smolyakoff, @eabliazimov, what do you think?

smolyakoff commented 4 years ago

Well, it's questionable. Let's have some poll to find out in a broader auditorium?

Personally, I like the idea of keeping recommended guidelines, because they educate people to some extent. Maybe they should be kept as separate documentation though so that we are not limited to C# guidelines only.