repo-tools

README

How to use this repository template

This template repository can be used to seed new git repositories in the gardener github organisation.

• Create the new repository based on this template repository
• Replacing placeholders:
  • In file REUSE.toml replace placeholder <repo name> with the name of your new repository.
  • In file CODEOWNERS replace <repo name> and <maintainer team>. Use the name of the github team in gardener teams defining maintainers of the new repository.
  • In files OWNERS and OWNERS_ALIASES replace <repo name>. Assign the appropriate reviewers and approvers.
• Set the repository description in the "About" section of your repository
• Describe the new component in additional sections in this README.md
• Ask the Owner of the gardener github organisation
  • to double-check the initial content of this repository
  • to create the maintainer team for this new repository
  • to make this repository public
  • protect at least the master branch requiring mandatory code review by the maintainers defined in CODEOWNERS
  • grant admin permission to the maintainers team of the new repository defined in CODEOWNERS

Maintain copyright and license information

By default all source code files are under Apache 2.0 and all markdown files are under Creative Commons license.

When creating new source code files the license and copyright information should be provided using corresponding SPDX headers.

/*
 * SPDX-FileCopyrightText: SAP SE or an SAP affiliate company and Gardener contributors
 *
 * SPDX-License-Identifier: Apache-2.0
 */

Third-party source code

If you copy third-party code into this repository or fork a repository, you must keep the license and copyright information (usually defined in the header of the file).

In addition you should adapt the REUSE.toml file and assign the correct copyright and license information.

Example REUSE.toml file if you copy source code into your repository:

version = 1
SPDX-PackageName = "Gardener <repo name>"
SPDX-PackageSupplier = "The Gardener project <gardener@googlegroups.com>"
SPDX-PackageDownloadLocation = "https://github.com/gardener/<repo name>"

[[annotations]]
path = ["*"]
precedence = "aggregate"
SPDX-FileCopyrightText = "SAP SE or an SAP affiliate company and Gardener contributors"
SPDX-License-Identifier = "Apache-2.0"

[[annotations]]
path = "**.md"
precedence = "aggregate"
SPDX-FileCopyrightText = "SAP SE or an SAP affiliate company and Gardener contributors"
SPDX-License-Identifier = "CC-BY-4.0"

# third-party - copied source code
[[annotations]]
path = "pkg/utils/validation/kubernetes/core/*"
precedence = "aggregate"
SPDX-FileCopyrightText = "2014 The Kubernetes Authors."
SPDX-License-Identifier = "Apache-2.0"

Example REUSE.toml file if you have forked a repository:

version = 1
SPDX-PackageName = "Gardener fork of kubernetes/autoscaler"
SPDX-PackageSupplier = "The Gardener project <gardener@googlegroups.com>"
SPDX-PackageDownloadLocation = "https://github.com/gardener/autoscaler"
# Comment: This is a fork of kubernetes/autoscaler (https://github.com/kubernetes/autoscaler)

[[annotations]]
path = ["*"]
precedence = "aggregate"
SPDX-FileCopyrightText = "2016-2018 The Kubernetes Authors."
SPDX-License-Identifier = "Apache-2.0"

[[annotations]]
path = ".ci/*"
precedence = "aggregate"
SPDX-FileCopyrightText = "SAP SE or an SAP affiliate company and Gardener contributors"
SPDX-License-Identifier = "Apache-2.0"

Modifications

In case you modify copied/forked source code you must state this in the header via the following text:

Modifications Copyright SAP SE or an SAP affiliate company and Gardener contributors

Get your reuse badge

To get your project reuse compliant you should register it here using your SAP email address. After confirming your email, an inital reuse check is done by the reuse API.

To add the badge to your project's README.md file, use the snipped provided by the reuse API.