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

Make the project REUSE-compliant #3859

Draft
wants to merge 25 commits into
base: master
Choose a base branch
from
Draft

Conversation

luixxiul
Copy link
Collaborator

@luixxiul luixxiul commented Dec 7, 2024

Closes #3796
Inspired by cryptpad/cryptpad#1149

REUSE is an initiative by FSFE, which intends to make licensing easier with best practices to display legal information through comment headers on source files that can be easily human and machine readable. The REUSE tool (reuse) is available and makes the process of applying licenses to files and compliance checking much easier.

This PR intends to add:

  • SPDX copyright and license comment headers
  • LICENSES directory with licenses used in the repository (AGPL-3.0-or-later and CC0-1.0)
  • REUSE.toml for files, to which a REUSE header should not be added (such as *.json)
  • GitHub Action "REUSE Compliance Check", so that compliance is checked automatically without running a pre-commit hook for Git locally

Please change MDAD Team and contributors as copyright holder to an appropriate one.

Suguru Hirahara added 24 commits December 8, 2024 04:59
REUSE is an initiative by FSFE, which intends to make licensing easier with best practices to display legal information through comment headers on source files that can be easily human and machine readable. The REUSE tool (reuse) is available and makes the process of applying licenses to files and compliance checking much easier.

Signed-off-by: Suguru Hirahara <[email protected]>
Signed-off-by: Suguru Hirahara <[email protected]>
…tory

flack.lock, flake.nix, and requirements.yml are taken care of with REUSE.toml

Signed-off-by: Suguru Hirahara <[email protected]>
Note that files in docs/assets/ are managed with REUSE.toml

Signed-off-by: Suguru Hirahara <[email protected]>
Signed-off-by: Suguru Hirahara <[email protected]>
It is also possible to check compliance by running reuse as pre-commit hook, which does not depend on GitHub. See: https://reuse.readthedocs.io/en/stable/readme.html#run-as-pre-commit-hook

Signed-off-by: Suguru Hirahara <[email protected]>
Computer-generated files cannot be copyrighted, and .gitignore cannot be copyrighted as well.
Example: https://reuse.software/faq/#bulk-license

Signed-off-by: Suguru Hirahara <[email protected]>
@luixxiul luixxiul marked this pull request as ready for review December 8, 2024 03:19
@luixxiul luixxiul marked this pull request as draft December 8, 2024 04:36
*.repo files are computer-generated ane cannot be copyrighted.

Signed-off-by: Suguru Hirahara <[email protected]>
@luixxiul luixxiul marked this pull request as ready for review December 8, 2024 04:41
@luixxiul luixxiul marked this pull request as draft December 8, 2024 04:43
@luixxiul
Copy link
Collaborator Author

Note it is easily possible to get the all authors of a file by using git shortlog -n -s.

@luixxiul luixxiul self-assigned this Dec 20, 2024
@luixxiul luixxiul marked this pull request as draft December 20, 2024 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Put a license notice to each file
1 participant