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

Adding template of copyright info for code #82

Open
brad-getpassport opened this issue Dec 23, 2021 · 4 comments
Open

Adding template of copyright info for code #82

brad-getpassport opened this issue Dec 23, 2021 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@brad-getpassport
Copy link

Suggest adding template copyright information at the top of all the python code files, or possibly all the code that looks something like this:

"""
Filename:
Copyright (c) 2021 - Present
All rights reserved.
"""

@jenstroeger
Copy link
Owner

That’s for using this repo with proprietary code?

We’ve been discussing the SPDX License Identifiers in issue #21. The repo here is under MIT License and you’re right: at the moment the files don’t have a license information header…

@jenstroeger jenstroeger added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 23, 2021
@brad-getpassport
Copy link
Author

Okay, so maybe mention it as a "best practice" in the README as ensuring that the proprietary code has a license is valuable.

@behnazh
Copy link
Collaborator

behnazh commented Dec 24, 2021

There is a difference between the copyright and license information. I recommend to add a pre-commit hook that checks such headers automatically and adds/fixes them if necessary, e.g., as the year changes.

@jenstroeger
Copy link
Owner

The insert-license pre-commit hook might be useful?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants