Skip to content
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 EF copyright and license to all files #741

Closed
Emily-Jiang opened this issue Jan 11, 2024 · 7 comments · Fixed by #756 or #762
Closed

Add EF copyright and license to all files #741

Emily-Jiang opened this issue Jan 11, 2024 · 7 comments · Fixed by #756 or #762

Comments

@Emily-Jiang
Copy link
Contributor

This project needs to address the comments below to use EF copyright (detailed below)

jakartaee/cdi-tck#522 (comment)

@Emily-Jiang
Copy link
Contributor Author

Emily-Jiang commented Jan 30, 2024

At today's CDI call, we have agreed that for the files not contributing by Red Hat, use the following copyright text:
Copyright (c) <year> Contributors to the Eclipse Foundation

@Azquelt
Copy link
Contributor

Azquelt commented Jan 30, 2024

Ok, so to check I have this right, every file should begin with a comment saying either:

 Copyright {year}, {owner}, and individual contributors
 by the @authors tag. See the copyright.txt in the distribution for a
 full listing of individual contributors.

or

Copyright (c) {year} Contributors to the Eclipse Foundation

Followed by:

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Where {year} is the year when the file was first published and {owner} is the copyright owner of the original contribution.

I have a few additional questions:

  1. Should we add this info to CONTRIBUTING.adoc so that new users can find it?

  2. I couldn't find the copyright.txt file mentioned in the first header. Should that exist somewhere?

  3. The first header says to check the @author tag for the copyright owner, whereas NOTICES.md says

    For more information regarding authorship of content, please consult the listed source code repository logs.

    Does that discrepancy need to be corrected?

@Emily-Jiang
Copy link
Contributor Author

Thank you @Azquelt for taking a further look at this.

Ok, so to check I have this right, every file should begin with a comment saying either:

 Copyright {year}, {owner}, and individual contributors
 by the @authors tag. See the copyright.txt in the distribution for a
 full listing of individual contributors.

Based on the EF Handbook, I think the following lines should be removed:

by the @authors tag. See the copyright.txt in the distribution for a
full listing of individual contributors.

@starksm64 please confirm.

or

Copyright (c) {year} Contributors to the Eclipse Foundation

Followed by:

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Where {year} is the year when the file was first published and {owner} is the copyright owner of the original contribution.

I have a few additional questions:

1. Should we add this info to CONTRIBUTING.adoc so that new users can find it?

yes. This is a requirement by EF Handbook. It was missed in the past. We need to add it for both cdi and cdi-tck project in this release.

2. I couldn't find the copyright.txt file mentioned in the first header. Should that exist somewhere?

3. The first header says to check the `@author` tag for the copyright owner, whereas NOTICES.md says
   > For more information regarding authorship of content, please consult the listed **source code repository logs**.
   
   
   Does that discrepancy need to be corrected?

The confusing text should be removed. See my comments above.

@Ladicek
Copy link
Contributor

Ladicek commented Jan 31, 2024

I would like to point out that certain files in the CDI API have a slightly different, shorter and more "to the point" license header, starting since #597 / #598. Going forward, maybe we should use that?

@Emily-Jiang
Copy link
Contributor Author

Emily-Jiang commented Jan 31, 2024

I would like to point out that certain files in the CDI API have a slightly different, shorter and more "to the point" license header, starting since #597 / #598. Going forward, maybe we should use that?

yes, that was exactly what I proposed by deleting the 2 lines as per my previous comments.

by the @authors tag. See the copyright.txt in the distribution for a
full listing of individual contributors.

@Emily-Jiang
Copy link
Contributor Author

@Azquelt I did not spot the deletion of the following lines from your PR:

by the @authors tag. See the copyright.txt in the distribution for a
full listing of individual contributors.
I keep this issue open for you to confirm the above sentences are removed form the files.

@Azquelt
Copy link
Contributor

Azquelt commented Feb 12, 2024

I've opened #762 to remove those two lines from all headers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants