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
chore(docs): Markdown housekeeping #1969
Conversation
It's likely to be frustrating as nobody actively monitors it (PRs/issues will do the job given current traffic)
@@ -7,10 +7,11 @@ | |||
<CheckEolTargetFramework>false</CheckEolTargetFramework> | |||
<Nullable>enable</Nullable> | |||
<ImplicitUsings>enable</ImplicitUsings> | |||
<Copyright>Copyright © 2013-23 Serilog Contributors</Copyright> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This flows up to the nuget landing page/ package metadata (and I think the FILEVERSIONINFO on the DLL)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm the Authors in the package (i.e., <Authors>Serilog Contributors</Authors>
) might get appended in some renderings?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems they are complementary per https://learn.microsoft.com/en-us/nuget/create-packages/package-authoring-best-practices#copyright, so leaving it that way
Thoughts on the open issue (in the overview) ? (i.e. add missing copyright headers in impl/test files and/or a copyright to the LICENSE and/or adjust the years per file) ? |
RE the copyright headers, I think sorting out the year range (© in the source files where they appear, and full range in the LICENSE file) would be my preference; no super strong feelings there though. |
Not sure what sorting out the year range would mean; make them consistent and then update them every year? Happy to do anything of the following that you want
|
aside/unrelated: @nblumhardt can you have a peep at File sink PR 258 please? |
Thanks for the follow-up. I think even just (2) - using |
@nblumhardt thanks for the response - will merge this and do it as a fresh PR another time One final question: do I remove headers from test files (a number 6 option I didnt propose!), or apply them consistently same as for source files (i.e. 4) ? |
I'm fine either way on the test files - they don't tend to "travel" like the source files do (e.g. Azure/serilog-sinks-azuredataexplorer#16). |
Hm, having seen that I'll apply them to the test files too, unless that becomes a truly huge change.. |
related: #1966
Open issues:
Some files are missing copyright headers. Many have incomplete years.
I feel the best answer is to remove them in favor of having one copyright year range in the NOTICE. This seems to be valid based on https://www.apache.org/legal/apply-license.html#copy-per-file and general SO searching. If this is not agreed, perhaps I could remove them from the test files only?
Failing that, I can add the header to all source files.