-
Notifications
You must be signed in to change notification settings - Fork 318
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
add copyright lines to all source files #1996
Conversation
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.
From the experience of doing the same in OpenLineage project - it would be better if this was a series of commits, each focused on particular file type only. This would allow spotting problems with particular file types.
For example, the copyright statement being top of file in .sh
files is wrong - it makes shebang not work properly. This is not easily found when looking through 300+ files 😉
Thanks, Maciej. I separated the changes into individual commits, one per file type. |
Codecov Report
@@ Coverage Diff @@
## main #1996 +/- ##
=========================================
Coverage 78.89% 78.89%
Complexity 1014 1014
=========================================
Files 197 197
Lines 5548 5548
Branches 421 421
=========================================
Hits 4377 4377
Misses 724 724
Partials 447 447
📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more |
Hi @mobuchowski I made the requested change -- please review when you have a moment. Thanks. |
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.
Thanks for adding the copyright to the source files, @merobi-hub! I did look over the files, and have the following suggestions:
- Remove the copyright from all
*.txt
and*.md
files - For
*.sh
files, the copyright has been added to the bottom of the scripts, and should be in the file header (I know this was done to address the comment by @mobuchowski, but ideally it should be in the header - see my suggestion below) - Is there a way to combining the copyright and license in a single header? That is:
java
/*
* Copyright 2018-2022 contributors to the Marquez project
* SPDX-License-Identifier: Apache-2.0
*/
bash
#!/bin/bash
#
# Copyright 2018-2022 contributors to the Marquez project
# SPDX-License-Identifier: Apache-2.0
py
# Copyright 2018-2022 contributors to the Marquez project
# SPDX-License-Identifier: Apache-2.0
Thanks for the feedback, @wslulciuc . Curious about why you want the line removed from .md and .txt files, assuming they're original to the project. Can you clarify? |
This is up for interpretation, but source files usually refer to code For the
Normally, I won't care as much but this is such a rare and infrequent change that will be copied for all new source files that I'm ok with extending the timeline to use a more compact header at the top of the source files (like I outlined in my change request). I know, not fun and really sorry for the extra effort here. I owe you! |
Signed-off-by: Michael Robinson <merobi@gmail.com>
4eb70dc
to
46b7ec0
Compare
Signed-off-by: Michael Robinson <merobi@gmail.com>
Signed-off-by: Michael Robinson <merobi@gmail.com>
Signed-off-by: Michael Robinson <merobi@gmail.com>
Signed-off-by: Michael Robinson <merobi@gmail.com>
Hi @mobuchowski and @wslulciuc , I think this is ready to be merged |
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.
Amazing work, @merobi-hub! 💯 🥇
Signed-off-by: Michael Robinson merobi@gmail.com
Problem
The project's source files lack a copyright, but inclusion of a copyright notice in every source file is an expectation of the LFAI.
Solution
This PR adds a copyright line to source files across the project (.py, .java, .sh), excluding non-source files and files where the line could create an issue.
Checklist
CHANGELOG.md
with details about your change under the "Unreleased" section (if relevant, depending on the change, this may not be necessary).sql
database schema migration according to Flyway's naming convention (if relevant)