Applies sensible defaults to ReSharper Code Cleanup in Octostache.sln.dotsettings
Runs a Cleanup sweep using the new rules
Adds details of expectations for contributors and how to run cleanup to README.md
How to review
There are two main components to this PR:
source/Octostache.sln.DotSettings contains the updates to the style rules
Everything else is the formatting changes resulting from running the R# cleanup across the codebase
In that clean-up, there were a couple of situations where R# was going to reduce the readability of code that had been crafted in a quite specific way. In these cases, and where it wasn't reasonable/easy to suppress the changes with a R# suppression comment, I've refactored the code to maintain as much of the original readability intent as possible, while preventing R#'s broom from messing with things. The main example of this is in source/Octostache/Templates/RecursiveDefinitionException.cs, but I recall there being one or two other instances where I had to massage the code to get everyone happy.
There should be no functional changes from any of this work.
Octostache.sln.dotsettingsHow to review
There are two main components to this PR:
source/Octostache.sln.DotSettingscontains the updates to the style rulesIn that clean-up, there were a couple of situations where R# was going to reduce the readability of code that had been crafted in a quite specific way. In these cases, and where it wasn't reasonable/easy to suppress the changes with a R# suppression comment, I've refactored the code to maintain as much of the original readability intent as possible, while preventing R#'s broom from messing with things. The main example of this is in
source/Octostache/Templates/RecursiveDefinitionException.cs, but I recall there being one or two other instances where I had to massage the code to get everyone happy.There should be no functional changes from any of this work.