Updating SA1636 header rules

[muiriswoulfe]

I've created this PR to update the default setting for checking the copyright header to warning, in order to bring it in line with the StyleCop defaults. The line is still commented out, but this change means the only modification required from the user is to uncomment the line -- they no longer need to uncomment and upgrade the severity.

I've also taken this opportunity to update the copyright message to the StyleCop default. I believe this header is preferable as it uses a more standard format (based on having checked many GitHub projects), and it aligns with StyleCop, which I believe is the goal of this .editorconfig project.

I've furthermore:

• Removed en-us from the explanatory URL, to allow it to default to the user's settings as for the other URLs in the comments.
• Update the minor version.
• Updated the revision date.

I'm happy to revert any of the changes you disagree with. Just let me know.

[RehanSaeed]

Thanks for provoking this conversation.

If you set it to a warning, you'll need a stylecop.json file to set the header. The duplication seems unnecessary, so I set it to none. Am I missing something?

If we no longer care about the StyleCop warning and stick with the new .editorconfig way, then we also no longer care about the defaults that StyleCop imposes, except if the wording itself is better.

From my conversations over Twitter/GitHub I think the Microsoft tooling team is trying to make .editorconfig the one stop shop for everything code style. There is a growing level of overlap and eventually, it may make sense to drop StyleCop altogether. For now though, this project tries to keep the two in sync. However, where there is overlap as in this case, I think it makes sense to prefer .editorconfig since there are analyzers and code fixes coming from Microsoft very soon that are built into the tooling.

Happy with the removal of en-us though.

[muiriswoulfe]

Thanks for taking a look at the PR.

My understanding was that to use the header validation, you need to enable both of the commented-out lines -- i.e. the file_header_template as well as dotnet_diagnostic.SA1636.severity. Perhaps the comment could be clarified to indicate that this is the case?

Regarding the copyright text itself, since we're no longer beholden to the StyleCop standards, may I suggest:

© PROJECT-AUTHOR

Many projects no longer seem to include "All rights reserved" as OSS licenses such as MIT waive rights, and the phrase no longer has any meaning in any jurisdiction. In addition, it seems that when you're using the official © symbol, the word "copyright" is no longer required. If you look at many corporate websites (including GitHub), you'll observe a copyright notice of this format and I believe this is sufficient for copyright enforcement as large companies would have legal teams ensuring adequate protection of their IP.

I'm only making suggestions here and I'm more than happy to go in whatever direction you like, as it is your project. If you wish, I'll just remove the en-us from the URL and leave everything else intact.

[RehanSaeed]

I'm all for clearer comments. The current text says:

# File Header (Uncomment to support file headers)

@henrygab knows more about legal stuff, so I defer to him on that side but what you're saying does make a lot of sense to me.

[henrygab]

@RehanSaeed -- I cannot provide legal advice. To avoid any doubt, I will defer and not provide review here.

[henrygab]

No review, but marking approved to avoid it showing as needing my review.

[RehanSaeed]

These new changes seem ok. Not sure about the removal of the word 'Copyright' give we have the symbol. You mention GitHub, do you have a link for that?

[muiriswoulfe]

You mention GitHub, do you have a link for that?

If you go to the bottom of every webpage on GitHub, you'll see "© 2020 GitHub, Inc."

My understanding -- but I admittedly make no claim to being a copyright lawyer -- is that copyright is included when using "(c)" as this has no defined meaning under copyright law. But "©" does, so the word "copyright" is redundant.

[RehanSaeed]

I'm convinced by your argument. If someone disagrees, it's just a template and easy to change.

[RehanSaeed]

@muiriswoulfe Thanks for the update.