Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Tracking] SPDX License headers in source files of repos #567

Open
1 of 32 tasks
dongsupark opened this issue Dec 7, 2021 · 0 comments
Open
1 of 32 tasks

[Tracking] SPDX License headers in source files of repos #567

dongsupark opened this issue Dec 7, 2021 · 0 comments
Labels
kind/feature A feature request

Comments

@dongsupark
Copy link
Member

dongsupark commented Dec 7, 2021

So far in most Flatcar repos, each source file has a common form of copyright headers like:

// Copyright 2021 Kinvolk GmbH
//
// Licensed under the Apache License, Version 2.0 (the "License");

We should make the header community-friendly and consistent all over the repo.

  • If possible, use a neutral term to cover all other authors, instead of Kinvolk. Ideally "Copyright The [project name] Authors".
    • We should not specify years, for simplifying maintenance in the future.
    • Keep original copyright statements if they exist.
  • Use SPDX License Identifier, instead of having License terms per source file.
  • Make sure a LICENSE file on the top-level source directory is correct w.r.t. the SPDX License.
  • Avoid using different copyright headers in different files, unless if that is necessary.

For example, each file has a header like that:

// Copyright The project_name Authors
// SPDX-License-Identifier: Apache-2.0

Repos with Apache 2:

Repos with MIT:

Repos with BSD or similar:

Repos with GPL or LGPL:

@dongsupark dongsupark added the kind/feature A feature request label Dec 7, 2021
dongsupark added a commit to flatcar/mantle that referenced this issue Dec 7, 2021
Use SPDX License headers for all source files, mainly to become
community-friendly and reduce maintenance issues.

See also flatcar/Flatcar#567.
dongsupark added a commit to flatcar/mantle that referenced this issue Dec 7, 2021
Use SPDX License identifier headers for all source files, mainly to
become community-friendly and reduce maintenance issues.

See also flatcar/Flatcar#567.
@pothos pothos moved this from No Status to Upcoming / Backlog in Flatcar tactical, release planning, and roadmap May 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature A feature request
Projects
Development

No branches or pull requests

1 participant