Skip to content

feat: mention license in headers#243

Merged
aeneasr merged 6 commits intomasterfrom
kg-license-headers-new-header
Nov 1, 2022
Merged

feat: mention license in headers#243
aeneasr merged 6 commits intomasterfrom
kg-license-headers-new-header

Conversation

@kevgo
Copy link
Copy Markdown
Contributor

@kevgo kevgo commented Oct 18, 2022

After some feedback, I have decided to mention the actual license in the file copyright headers. Apache recommends a lengthy header:

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License 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.    

I think this lengthy header is a relict from the 1970s when the open-source started to form and people had to over-communicate the idea. These days, everybody knows what the Apache license is, so I think a shorter form using the official SPDX-identifier is better since it is human-readable and machine-understandable.

// Copyright © 2021 Ory Corp
// SPDX-License-Identifier: Apache-2.0

Related Issue or Design Document

https://github.com/ory-corp/general/issues/602

Checklist

  • I have read the contributing guidelines
    and signed the CLA.
  • I have referenced an issue containing the design document if my change
    introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security
    vulnerability. If this pull request addresses a security vulnerability, I
    confirm that I got approval (please contact
    security@ory.sh) from the maintainers to push
    the changes.
  • I have added tests that prove my fix is effective or that my feature
    works.
  • I have added the necessary documentation within the code base (if
    appropriate).

@kevgo kevgo marked this pull request as draft October 18, 2022 14:50
@kevgo kevgo marked this pull request as ready for review November 1, 2022 12:05
@aeneasr aeneasr merged commit c2fb71f into master Nov 1, 2022
@aeneasr aeneasr deleted the kg-license-headers-new-header branch November 1, 2022 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants