NGI - Updating licensing aspects according to REUSE #480
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello,
I work for the Free Software Foundation Europe (FSFE), and we have been working with the NGI framework, helping projects with their licensing and copyright management. After a quick check on your repository, I would like to propose some updates regarding copyright and licensing information. (Please keep in mind that this is simply a guideline for your project to consider). REUSE is an FSFE-developed initiative intended to make licensing easier by establishing a single way to display all copyright and licensing information through comment headers on source files that can be human- and machine-readable.
REUSE Features:
Copyright and Licensing Information in each file
One of the main features of REUSE is that each file in the repository contains copyright and license information with the help of a comment header. To serve as a guideline and a practical example of how REUSE looks, I have added the header to some of the files in your repository e.g.
app/
python/
but quite some other files still need such info. I've taken the copyright information from theLICENSE
file. So, please double-check that the personal information in the headers is correct and consistent, otherwise, please update that information in the headers.Please, keep in mind that you can also change the year in the headers depending on your preference.
Please note that REUSE has also an option to add this legal information for binary and uncommentable files like
json
files, as well as for insignificant files and no copyrightable files such as.gitignore
. An appropriate license for the documentation files in your repository is also encouraged.LICENSES directory in the root of the project with the licenses used on the repository:
I included in this directory a file with the text of the BSD-3-Clause license. I did not do anything with the existing
LICENSE
file in the root of the directory. It is up to you if you want to keep it or delete it, however, this won't affect the REUSE specification. Please also be aware, that if some pieces of your project use a different license, such license text should be added to theLICENSES/
directory as well as to the specific files.Please feel free to check the REUSE documentation and the helper tool , and if you are interested in making your project REUSE compliant, please add the legal information to the missing files. I am also available if you want support with the process.
Wide range of tools
In case you find REUSE useful, we offer other tools to help you continuously check and display compliance with the REUSE guidelines. For instance, you can automatically run reuse lint on every commit as a pre-commit hook for Git. And, it can be easily integrated into your existing CI/CD processes to continuously test your repository and its changes for REUSE compliance
Hope that helps and thank you very much for the amazing job!
I am happy to answer any question that you might have and happy to help in the process of helping your project to become REUSE compliant!