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

(NFC) (dev/core#878) Simplify copyright header (D7) #587

Merged
merged 1 commit into from
Nov 14, 2019

Conversation

totten
Copy link
Member

@totten totten commented Nov 14, 2019

Overview

This implements https://lab.civicrm.org/dev/core/issues/878 and aims to reduce git-noise.

Before

  • The standard header used on most files includes a copyright declaration - along with a version number, range of years, summary of the license terms, and link for details. The headers periodically require a trivial update when a new year comes.

After

  • The standard header used on most files includes a copyright declaration - along with a very brief license summary and link for details. The headers no longer require a trivial update when a new year comes.

Comments

As you can see in 878, the comparable headers among other reputable projects are varied. They (almost always?) include the copyright declaration and some reference to the license terms; but they differ on whether to include specific version numbers and years in the declaration. However, this means that there are good precendents (such as Google's Angular and Facebook's React) which use a convention similar to this updated one.

This PR only changes files which already use the standard header (modulo trivial formatting). The bulk of the switch was performed with https://gist.github.com/totten/85d368a512f7dcda9319dfb57a0f8ecf

@civibot civibot bot added the 7.x-master label Nov 14, 2019
@civibot
Copy link

civibot bot commented Nov 14, 2019

(Standard links)

@totten totten merged commit 7b0de1c into civicrm:7.x-master Nov 14, 2019
@totten totten deleted the 7.x-simplehead branch November 14, 2019 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant