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

Add templates for REUSE Software #7

Closed
Ludee opened this issue Mar 24, 2022 · 3 comments · Fixed by #66
Closed

Add templates for REUSE Software #7

Ludee opened this issue Mar 24, 2022 · 3 comments · Fixed by #66
Assignees
Labels
part: backend 🧱 Concerns backend components part: docu 📖 Concerns the documentation priority: critical 🔥 Critical priority status: completed ✔️ Has been completed type: feature 🛠️ Implementation of a new feature

Comments

@Ludee
Copy link
Member

Ludee commented Mar 24, 2022

We make licensing easy for humans and machines alike. We solve a fundamental issue that Free Software licensing has at the very source: what license is a file licensed under, and who owns the copyright?

  1. Choose and provide licenses
  2. Add copyright and licensing information to each file
  3. Confirm REUSE compliance

https://reuse.software/

Examples

All code files (.py, .yml) should contain the header:

# SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
#
# SPDX-License-Identifier: MIT

Markdown and text files:

<!--
SPDX-FileCopyrightText: Coraline Ada Ehmke <https://where.coraline.codes/>
SPDX-License-Identifier: CC-BY-4.0
-->

RST files:

..
  SPDX-FileCopyrightText: Ludwig Hülk <@Ludee> © Reiner Lemoine Institut

  SPDX-License-Identifier: MIT

Use

UPDATE:

  • "If the author is being paid by their employer to create a work, the employer is often the copyright holder."
    In order to fulfil both criteria (attribution of the copyright holder and scientific citation of the author), it is necessary to add both in the REUSE string.
  • To add the year is not a MUST and doesn' offer any benefit, so leave out the year!
    Source: https://reuse.software/faq/#copyright-holder-author

SPDX-FileCopyrightText: [author] [alias] [copyright holder] <[contact address]>

Option 1: Comment per line

# SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut
#
# SPDX-License-Identifier: MIT

Option 2: Comment block

# -*- coding: utf-8 -*-

""" Title of the file

Short description with more details.

SPDX-FileCopyrightText: Ludwig Hülk (Ludee) © Reiner Lemoine Institut

SPDX-License-Identifier: MIT
"""

Option 3: .license file

Option 4: REUSE.toml

@Ludee Ludee added part: docu 📖 Concerns the documentation type: enhancement ⚙️ Improvement of an existing feature labels Mar 24, 2022
@Ludee Ludee added this to the Complete repository milestone Mar 24, 2022
@Ludee Ludee self-assigned this Mar 24, 2022
jh-RLI added a commit that referenced this issue Aug 16, 2023
also cnfigure te lint and test tools #21
add reuse identier #7
@Ludee Ludee added part: backend 🧱 Concerns backend components type: feature 🛠️ Implementation of a new feature status: active 🚧 Work in progress priority: critical 🔥 Critical priority and removed type: enhancement ⚙️ Improvement of an existing feature labels Aug 17, 2023
@Ludee
Copy link
Member Author

Ludee commented Aug 24, 2023

There is a pre-commit hook for REUSE:
https://reuse.software/dev/#pre-commit-hook

@Ludee
Copy link
Member Author

Ludee commented Aug 25, 2023

Jonas Huber © Reiner Lemoine Institut https://github.com/jh-RLI

@Ludee
Copy link
Member Author

Ludee commented Nov 14, 2024

The latest version of REUSE moved from .reuse/dep5 to REUSE.toml.

@Ludee Ludee moved this from To do to In progress in super-repo-v0.2.0 Nov 27, 2024
Ludee added a commit that referenced this issue Nov 27, 2024
Ludee added a commit that referenced this issue Nov 27, 2024
Ludee added a commit that referenced this issue Nov 27, 2024
Ludee added a commit that referenced this issue Nov 27, 2024
Ludee added a commit that referenced this issue Nov 27, 2024
@Ludee Ludee closed this as completed in #66 Nov 27, 2024
@github-project-automation github-project-automation bot moved this from In progress to Done in super-repo-v0.2.0 Nov 27, 2024
@Ludee Ludee reopened this Nov 27, 2024
@github-project-automation github-project-automation bot moved this from Done to In progress in super-repo-v0.2.0 Nov 27, 2024
Ludee added a commit that referenced this issue Nov 27, 2024
Ludee added a commit that referenced this issue Nov 27, 2024
Ludee added a commit that referenced this issue Nov 27, 2024
Ludee added a commit that referenced this issue Nov 27, 2024
@Ludee Ludee moved this from In progress to Done in super-repo-v0.2.0 Nov 27, 2024
@Ludee Ludee closed this as completed Nov 27, 2024
@Ludee Ludee added status: completed ✔️ Has been completed and removed status: active 🚧 Work in progress labels Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
part: backend 🧱 Concerns backend components part: docu 📖 Concerns the documentation priority: critical 🔥 Critical priority status: completed ✔️ Has been completed type: feature 🛠️ Implementation of a new feature
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant