aws / aws/crypto-tools

Simplify copyright headers

Open
#15 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
35
Forks
9
PR merge metrics
No merged PRs in 30d

Description

We no longer need to include year statements in our file header copyright statements. We also no longer need to include the full license statement, and can simply reference the SPDX identifier.

For example, rather than:

```python
# Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
```

we can simply include:

```python
# Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0
```

We should update our repos for simplicity and consistency and add checks in our CI to verify that the header lines are present in every source file.

Contributor guide

Open the contributing guide

Research direction

No source files, repositories, or tests are named; begin by inventorying the repositories' source files and CI configuration. Compare existing headers with the requested SPDX form, then verify that every source file is covered and that CI detects missing or outdated headers.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.