-
Notifications
You must be signed in to change notification settings - Fork 4
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
General Cleanup, update copyright notices, remove some old stuff #43
Conversation
Workflow Status ReportGenerated for commit a5a43e6 on Mon Jan 27 18:14:56 UTC 2025. In case of failure, clippy warnings and rustfmt changes (if any) will be indicated as CI check warnings in the file comparison view. Documentation: Read Online Download Coverage Report: Read Online Download Note: Online versions of documentation and coverage reports may not be available indefinitely, especially after the pull request was merged. Code Coverage ReportCoverage target is 80%. Expand to view coverage statistics
Total coverage: 54.20% |
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.
LGTM! :) See just one comment below (and remember squashing 😉)
This commit replaces all copyright notices provided in source code file, solving some smaller issues with the previous one: - Maintaining year numbers in copyright notices for each file separately is a chore, not very accurate (esp. if code is moved between files), and this approach has already been abandoned by larger projects such as [curl](https://daniel.haxx.se/blog/2023/01/08/copyright-without-years/). Therefore, we have removed copyright years from all file headers, keeping only the year numbers referring to the project as a whole in README, NOTICE and LICENSE files. - The previous header states the copyright owner as "The NAMIB Project Contributors", which is problematic in the sense that A) the project is no longer active, B) never was a legal entity in the first place and C) is no longer accurate given third-party contributions. The new header instead refers to "The libcoap-rs Contributors", with the NOTICE and README files being a bit more specific and stating the author to be "Hugo Hakim Damer, the NAMIB Project Members, and the other libcoap-rs Contributors", which provides at least one legal entity (me) and a general term encompassing all contributors. Additionally, we now provide a NOTICE file containing more detailed information on copyright ownership, maintainers, contact information, etc. The approach of using a general "The XYZ Contributors" term is best practice in e.g., [Linux Foundation projects](https://www.linuxfoundation.org/blog/blog/copyright-notices-in-open-source-software-projects), and the NOTICE file takes some inspiration from the [Eclipse Foundation project guidelines](https://www.eclipse.org/projects/handbook/#legaldoc-notice).
…es in cargo publish
02d4230
to
7ed4bfa
Compare
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.
See one last-minute nit below, otherwise: LVGTM! :) 🚀
a804de4
to
a5a43e6
Compare
This PR performs some general cleanup, removing obsolete and inaccurate documentation as well as old GitLab-related files.
Also, it replaces the old copyright notices in all file headers, solving some smaller issues with the previous one:
Maintaining year numbers in copyright notices for each file separately
is a chore, not very accurate (esp. if code is moved between files),
and this approach has already been abandoned by larger projects such
as curl.
Therefore, we have removed copyright years from all file headers,
keeping only the year numbers referring to the project as a whole
in README, NOTICE and LICENSE files.
The previous header states the copyright owner as "The NAMIB Project
Contributors", which is problematic in the sense that A) the project
is no longer active, B) never was a legal entity in the first place
and C) is no longer accurate given third-party contributions.
The new header instead refers to "The libcoap-rs Contributors", with
the NOTICE and README files being a bit more specific and stating the
author to be "Hugo Hakim Damer, the NAMIB Project Members, and the
other libcoap-rs Contributors", which provides at least one legal
entity (me) and a general term encompassing all contributors.
Additionally, we now provide a NOTICE file containing more detailed
information on copyright ownership, maintainers, contact information,
etc.
The approach of using a general "The XYZ Contributors" term is best
practice in e.g., Linux Foundation projects, and the NOTICE file takes some
inspiration from the Eclipse Foundation project guidelines.
Also, updated the copyright years that remain to consistently be 2021-2025.