Look for SPDX - Githubissues

CNES / EleFits

A modern C++ API on top of CFitsIO

https://cnes.github.io/EleFits

Other

13 stars 5 forks source link

Look for SPDX #18

Closed kabasset closed 2 years ago

kabasset commented 2 years ago

SPDX looks like a good alternative to traditional license files and notices. Would be nice to see how to apply it. A first task would be to replace preamble notices, which can be automated.

kabasset commented 2 years ago

Note: Since documentation is generated from comments and source files, it shares the same license as the code. Explicitly stating that comments are CC-BY-4.0 is not enough, since declarations are also part of the documentation?

kabasset commented 2 years ago

Although not mandatory, each file should start with a notice which contains the following lines, unordered:

A copyright notice
The name of the project
The license id

For example:

// Copyright (C) 2019-2022, CNES and contributors (for the Euclid Science Ground Segment)
// This file is part of EleFits.
// SPDX-License-Identifier: LGPL-3.0-or-later

kabasset commented 2 years ago

Note: Assuming there was at least a "release" every year, the copyright notice is built as:

Copyright (C) <first-release-year>-<lastest-release-year>, <list-of-contributors> (<anything-you-wish-to-display>)

Not clear to me if a commit is a release (I guess so, since anyone can use any commit) or not. If no release were made a given year, it must be excluded, e.g. 2012-2016, 2018-2022 (which is ugly => release often :p ).