greenbone / pontos

Common utilities and tools maintained by Greenbone Networks
https://greenbone.github.io/pontos/
GNU General Public License v3.0
9 stars 11 forks source link

Change licensing templates to use recommended format from REUSE v3.0 #453

Open bernhardreiter opened 1 year ago

bernhardreiter commented 1 year ago

Currently licensing headers have lines like (for Go):

// Copyright (C) <year> <company>
//
// SPDX-License-Identifier: AGPL-3.0-or-later
//
// This program is free software: you can redistribute it and/or modify
...

the current standard https://reuse.software/spec/ v3.0 suggests to use

// SPDX-FileCopyrightText: <year> <company> <https://greenbone.net>
//
// SPDX-License-Identifier: AGPL-3.0-or-later

Advantages: The rights holder(s) can be identified better automatically. The marking is kept flexible for the future.

bernhardreiter commented 1 year ago

https://github.com/Intevation/pontos/tree/update-headers-go-reuse30 does both for the AGPL Go template with https://github.com/greenbone/pontos/compare/main...Intevation:pontos:update-headers-go-reuse30 .

Note that the command must be called with a contact address, e.g. like

pontos-update-header --company 'Greenbone Networks GmbH <https://greenbone.net>' -l AGPL-3.0-or-later -d cmd/
bjoernricks commented 1 year ago

Could you create a PR and we also need a possibility to update and keep existing headers.

bernhardreiter commented 1 year ago

@bjoernricks would you accept a PR that only updates AGPL and go?

bjoernricks commented 1 year ago

We need this tool for updating the copyright in many repos and files. As long it stays backwards compatible or has an upgrade path and there are unit tests I am fine with every PR.

cfi-gb commented 1 year ago

Now that #681 has been merged this might be closed.