Skip to content

Commit

Permalink
Updating SA1636 header rules (#36)
Browse files Browse the repository at this point in the history
* Updating default severity of SA1636 to match that of StyleCop defaults

* Updating date

* Further improvements for alignment with StyleCop

* Addressing some PR feedback
  • Loading branch information
muiriswoulfe committed Oct 4, 2020
1 parent f9b72aa commit 52a6961
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Version: 1.6.0 (Using https://semver.org/)
# Updated: 2020-07-28
# Version: 1.6.1 (Using https://semver.org/)
# Updated: 2020-10-01
# See https://github.com/RehanSaeed/EditorConfig/releases for release notes.
# See https://github.com/RehanSaeed/EditorConfig for updates to this file.
# See http://EditorConfig.org for more information about .editorconfig files.
Expand Down Expand Up @@ -65,14 +65,14 @@ indent_style = tab

##########################################
# File Header (Uncomment to support file headers)
# https://docs.microsoft.com/en-us/visualstudio/ide/reference/add-file-header
# https://docs.microsoft.com/visualstudio/ide/reference/add-file-header
##########################################

# [*.{cs,csx,cake,vb,vbx}]
# file_header_template = <copyright file="{fileName}" company="PROJECT-AUTHOR">\nCopyright (©) PROJECT-AUTHOR. All Rights Reserved\n</copyright>
# file_header_template = <copyright file="{fileName}" company="PROJECT-AUTHOR">\ PROJECT-AUTHOR\n</copyright>

# SA1636: File header copyright text should match
# Justification: .editorconfig supports file headers, so specifying a stylecop.json file with the file header is not needed.
# Justification: .editorconfig supports file headers. If this is changed to a value other than "none", a stylecop.json file will need to added to the project.
# dotnet_diagnostic.SA1636.severity = none

##########################################
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A very generic [.editorconfig](https://github.com/RehanSaeed/EditorConfig/blob/m
### .NET Code Style

Extensive code style settings for C# and VB.NET have been defined that require the latest C# features to be used.
All C# related code styles are consistent with [StyleCop's](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) default styles.
All C# related code styles are consistent with [StyleCop's](https://github.com/DotNetAnalyzers/StyleCopAnalyzers) default styles, with the exception of the file header definition, which has been changed to a more modern format.
All .NET naming conventions are consistent with the .NET Framework Design Guideline's [Naming Guidelines](https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/naming-guidelines).

# What is .editorconfig?
Expand Down
2 changes: 1 addition & 1 deletion Samples/CSharp/FieldsExamples.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// <copyright file="FieldsExamples.cs" company="PROJECT-AUTHOR">
// Copyright (©) PROJECT-AUTHOR. All Rights Reserved
// © PROJECT-AUTHOR
// </copyright>

namespace CSharpSamples
Expand Down

0 comments on commit 52a6961

Please sign in to comment.