Skip to main content
Version: 0.5.0

Licensing and copyright

The Jayvee repository is REUSE compliant, meaning that it fulfills the REUSE Specification by the Free Software Foundation Europe (FSFE). This makes clear under which license each project file is licensed under and who owns the copyright, not only for humans but also for machines.

This is done by explicitly adding copyright and licensing information to each file of the project. This is achieved by either using a comment header or a separate *.license file in case comments are not possible.

See https://reuse.software/ more information.

The entire project is licensed under AGPL-3.0-only, the license file can be found here. The copyright holder is the Friedrich-Alexander-Universität Erlangen-Nürnberg.

How to submit a REUSE compliant contribution?​

In case you want to contribute to the project, you will need to ensure that all of your contributed files are REUSE compliant. In order to achieve this, you need to add a key-value pair for both copyright and licensing information following this schema:

SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg

SPDX-License-Identifier: AGPL-3.0-only

In case a file allows comments, use single-line comments to add the copyright and licensing information at the top of the file. Otherwise, create a corresponding *.license file with the text above as its content. You can have a look at some existing project files to get an impression on it is done in practice.

For files with common file extensions, you can use the reuse CLI tool to add licensing and copyright information automatically.

For more details, you can have a look at the Getting Started tutorial on the REUSE website.

How to validate REUSE compliance?​

When you make a contribution and open a new pull request, the CI checks whether your contribution is REUSE compliant using the reuse CLI tool.

In order to validate REUSE compliance in your local development environment, you have to install the reuse CLI tool and run the following command in the projects' root folder:

reuse lint

You can also set up a pre-commit hook, so the above command is run before each commit. See here for details on how to set it up.

How to hide *.license files in IDEs​

During development, the file explorer of your IDE may be cluttered due to the numerous *.license files in the project. Luckily, most IDEs allow hiding certain files, e.g. by specifying a pattern to exclude them from the explorer.

Below, you can find instructions on how to hide *.license files in commonly used IDEs: