-
Notifications
You must be signed in to change notification settings - Fork 25
Add License/Copyright to all files #90
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
Comments
@ThomasWaldmann commented in the PR (#89):
So perhaps we'll go the |
Here's an example of a short header with description, copyright and license: https://github.com/micropython/micropython/blob/master/lib/littlefs/lfs2.c#L1-L7 |
That looks pretty neat. One liner description (or longer if needed), followed by (in our case) 1 copyright line, followed by e.g. # ESP32 ULP Co-Processor Assembler
#
# Copyright 2018-2023, the micropython-esp32-ulp authors, see AUTHORS file.
# SPDX-License-Identifier: MIT or maybe: """
ESP32 ULP Co-Processor Assembler
Copyright 2018-2023, the micropython-esp32-ulp authors, see AUTHORS file.
SPDX-License-Identifier: MIT
""" even though I wonder whether the 2nd example would be interpreted as a string and use thus more memory? |
If one puts the "current year" there, one has to run around once a year and update the years everywhere. |
You only need to update the year if you change the code (in that year). It's OK for a copyright to be "old" if the code is also "old". |
Btw, saw in some other code today, there's also a # ESP32 ULP Co-Processor Assembler
#
# SPDX-FileCopyrightText: 2018-2023, the micropython-esp32-ulp authors, see AUTHORS file.
# SPDX-License-Identifier: MIT |
I have now created PR #95, adding licence headers everywhere. |
Currently we have only a general LICENSE file in the repo root.
Having license/copyright information in each file makes it very clear for anyone who copies the file what the license/copyright is.
We can either add a short header using the
SPDX-License-Identifier
format. Or a long one like in themicropython
repo.The text was updated successfully, but these errors were encountered: