rl-institut / super-repo

A template repo to test and document repo elements and features
https://rl-institut.github.io/super-repo/
MIT License
13 stars 0 forks source link

Add templates for REUSE Software #7

Open Ludee opened 2 years ago

Ludee commented 2 years ago

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) should contain the header:

# SPDX-FileCopyrightText: 2016, 2018-2019 Jane Doe <jane@example.com>
# SPDX-FileCopyrightText: 2019 Example Company
#
# SPDX-License-Identifier: GPL-3.0-or-later

Markdown and text files:

<!-- SPDX-FileCopyrightText: 2021 Number6174 -->
<!-- SPDX-License-Identifier: CC0-1.0 -->

Use

UPDATE:

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 commented 1 year ago

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

Ludee commented 1 year ago

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

Ludee commented 3 days ago

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