skyra-project / arkadia

.NET Microservices for Skyra
Apache License 2.0
1 stars 0 forks source link

qol: add stylecop analysers + settings for .NET projects. #52

Open Tylertron1998 opened 3 years ago

Tylertron1998 commented 3 years ago

with stylecop, you can configure specific style related settings that are executed in a build time analyzer - allowing others to easily follow our coding standard regardless of tooling (it works via a compiler plugin, so regardless of IDE choice).

I propose the following: we have two different stylecop configurations - both the same, except one (CI one) will have failures instead of warnings. This means people can see what styles we have - but are not forced to adhere to them until the PR is ready. Having them as errors by default is awful and can really hinder progress, as when you're mocking something up or writing some test code, you can quickly build and test without worrying about making it pretty. Then, CI can run the 'strict' one, which will fail if anything is not adhered.