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

docs: add license headers #477

Merged
merged 2 commits into from
Jan 12, 2024

Conversation

afuetterer
Copy link
Contributor

@afuetterer afuetterer commented Jan 10, 2024

Description

This PR adds a new pre-commit hook, that adds this license headers to each python module:

# SPDX-FileCopyrightText: 2020 PANGAEA (https://www.pangaea.de/)

# SPDX-License-Identifier: MIT

This should be sufficient, no need to copy the whole MIT license text into a module.

Two things I am unsure about:

  • the copyright years though. You want to change those to the year the module was created, e.g. 2021, 2022, etc?
  • the copyright text could potentially include the list of authors per module

What do you think?

Types of changes

  • Build related changes
  • Documentation content changes

Checklist

  • I have read the contributor guide.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link

github-actions bot commented Jan 10, 2024

📋 Pytest Results

18 tests  ±0   18 ✅ ±0   25s ⏱️ +4s
 1 suites ±0    0 💤 ±0 
 1 files   ±0    0 ❌ ±0 

Results for commit 63669a8. ± Comparison against base commit c7cb7e5.

♻️ This comment has been updated with latest results.

@huberrob
Copy link
Contributor

A good one! I think the year should be kept but it should be the year, the file has been created. But since within the EU copyright is valid 70 years after creation and the creation year is clearly visible at Githuib, we could also just leave it away..

@afuetterer
Copy link
Contributor Author

Fixed the merge conflict.

@afuetterer
Copy link
Contributor Author

You can decide on this one.

This hook will add the license header when you commit a new python module.

Copy link

📋 Code Coverage

Code Coverage

Package Line Rate Branch Rate Health
. 51% 35%
config 100% 100%
controllers 85% 56%
evaluators 64% 37%
harvester 63% 52%
helper 66% 55%
models 80% 87%
Summary 70% (6633 / 9461) 60% (2815 / 4672)

@huberrob huberrob merged commit 708fe43 into pangaea-data-publisher:master Jan 12, 2024
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants