Code2Gether-Discord / Congo

Generic web store learning project that consists of three ASP.NET Core projects
https://code2gether-congo.azurewebsites.net/
11 stars 2 forks source link

Codify C# coding conventions #28

Closed ThorstenSauter closed 3 years ago

ThorstenSauter commented 3 years ago

In order to make code more readable and consistent, a root .editorconfig file should be created. In the meeting on 2021-10-02 it was decided to mostly follow Microsoft coding conventions. I took this to mean we should follow the guidelines set out in this article which references the dotnet runtime project as its basis. Their .editorconfig would therefore be a good starting point.

If our individual subprojects want to define further rules, they can do so with a nested .editorconfig file.

Questions that should be answered:

If any other questions arise, feel free to ask them here and we can discuss them.

@pobiega I'm still not clear on the labels or projects to assign to these all-encompassing issues, would you be so kind as to assign the appropriate ones?

pobiega commented 3 years ago
  1. I personally prefer var, but I know not everyone else does. I suggest we allow both and suggest neither.
  2. I like them but don't feel strongly enough to turn on suggestions. I suggest allow but not suggest.
  3. Allow TODOs. Otherwise, someone might just remove the comment and then we are worse of.

No further questions from me at this point, the suggested editorconfig looks good!