Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Code Analysis Rulesets and File Headers #55

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added Code Analysis Rulesets and File Headers #55

wants to merge 1 commit into from

Conversation

James231
Copy link

Includes code quality improvments:

  • Code analysis rulesets files list acceptable an unacceptable coding styles. When you perform a build in Visual Studio, build errors are returned when these rules are broken. I have added ruleset files used by Microsoft. To give an example, these rulsets expect using statements to be ordered alphabetically and builds fail if they are not. When you don't follow the rules you get the usual red underlines in Visual Studio and can use Ctrl + . to get VS to fix them automatically.
  • I've added file headers to all cs files. This is also required as part of the rulsets. The header is set in stylecop.json. The file header looks like:
// -------------------------------------------------------------------------------------------------
// C# Inn Website - © Copyright 2020 - C# Inn
// Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
// -------------------------------------------------------------------------------------------------

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant