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

Adopt consistent format for Copyright notices #86680

Open
keith-zephyr opened this issue Mar 5, 2025 · 8 comments
Open

Adopt consistent format for Copyright notices #86680

keith-zephyr opened this issue Mar 5, 2025 · 8 comments
Labels
Process Tracked by the process WG

Comments

@keith-zephyr
Copy link
Contributor

keith-zephyr commented Mar 5, 2025

Introduction

The contributor guidelines instruct developers to follow the Linux foundation best practices for copyrights in open source projects.

Problem description

Zephyr isn't following the Linux foundation recommendation. Some contributors always update the copyright, many others only include a copyright message on the first commit.

Proposed change

Adopt a standard Copyright message for Zephyr. One of

Copyright (c) YYYY The Zephyr Project Authors
Copyright (c) YYYY The Zephyr Project Contributors
Copyright (c) YYYY Zephyr Project Members

The first 2 options come from the Linux foundation. The 3rd option has limited use in the tree now (15 results)

@keith-zephyr keith-zephyr added the Process Tracked by the process WG label Mar 5, 2025
@github-project-automation github-project-automation bot moved this to To do in Process Mar 5, 2025
@keith-zephyr
Copy link
Contributor Author

If this is adopted, we would not remove any existing copyright notices in the tree, per the LF recommendation.

  • New files would include the Zephyr Project copyright and optionally the author's own copyright.
  • When modifying files, the Zephyr Project copyright is appended to the existing copyright notice for the file.

@keith-zephyr
Copy link
Contributor Author

Another discussion topic is the Copyright year format. The Zephyr tree shows the following patterns:

Copyright (c) 2019
Copyright (c) 2022-2024
Copyright (c) 2017, 2019
Copyright (c) 2011-2012, 2014-2015

I propose we recommend only including the current year in the copyright notice. When amending a a file, there is no need to update the date in copyright notice. Authors are free to add a new copyright line.

For US copyright, only the year of the first publication is needed.

@henrikbrixandersen
Copy link
Member

Are you suggesting we require contributors to sign over copyright of their work to the Linux Foundation? If so, why?

@nashif
Copy link
Member

nashif commented Mar 6, 2025

Are you suggesting we require contributors to sign over copyright of their work to the Linux Foundation? If so, why?

where is this being suggested?

The recommendation of the LF clearly state:

...
These statements are intended to communicate the following:

- the work is copyrighted;
- the contributors of the code licensed it, but retain ownership of their copyrights; and
- it was licensed for distribution as part of the named project.
...

Proposed change

Adopt a standard Copyright message for Zephyr. One of

Copyright (c) YYYY The Zephyr Project Authors
Copyright (c) YYYY The Zephyr Project Contributors

This one matches the recommendation, but I would recommend keeping it simple without years and (c), because this is the reason you want to go this route. notices being out of date all the time and also different companies using (c) in different ways and formats, so keep it simple and just foillow the recommendation to the letter.

Copyright (c) YYYY Zephyr Project Members

please no, member has a special meaning in this context, ie. being a member of the project (silver, platinum, etc.)

@keith-zephyr
Copy link
Contributor Author

This one matches the recommendation, but I would recommend keeping it simple without years and (c), because this is the reason you want to go this route. notices being out of date all the time and also different companies using (c) in different ways and formats, so keep it simple and just foillow the recommendation to the letter.

I agree with this. I opened this issue after seeing a PR author change the copyright year in an existing file. If we drop the year, then it's easier for compliance checks to enforce the format as well.

@keith-zephyr
Copy link
Contributor Author

Are you suggesting we require contributors to sign over copyright of their work to the Linux Foundation? If so, why?

As Anas noted, no one signs over copyright with this proposal. The github history is still the authoritative source of truth for copyright.

@henrikbrixandersen
Copy link
Member

Are you suggesting we require contributors to sign over copyright of their work to the Linux Foundation? If so, why?

As Anas noted, no one signs over copyright with this proposal. The github history is still the authoritative source of truth for copyright.

Sounds good, sorry I misread the proposal initially. The whole "Zephyr Project Members" threw me off, as that is a distinct group of LF/Project member companies (as already pointed by @nashif). We need our documentation to be very clear about the fact, that there is no copyright reassignment, as this is known to cause contribution issues at least for some companies.

Personally, I'd prefer the consistent copyright notice to say "The Zephyr Project Contributors" as "contributor" is already a well-established term in the Zephyr community (see e.g. https://docs.zephyrproject.org/latest/contribute/index.html).

@jfischer-no
Copy link
Collaborator

"Copyright The XYZ Author" should not be optional, but always required when adding a new file to the project. It is established practice and does not contradict https://www.linuxfoundation.org/blog/blog/copyright-notices-in-open-source-software-projects.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Process Tracked by the process WG
Projects
Status: To do
Development

No branches or pull requests

4 participants