What format should our * @license declaration be?

Unknown
Unknown
in Dev & Ops

@tburry has told me this is legally required for the license to hold on the code in each file so we should probably get it correct. Right now we have a few different variations floating around mostly coming from things that get copy pasted about. They should be easy enough to make consistent with a find and replace.

In repo link

/**
 * @license https://github.com/vanilla/vanilla/blob/master/LICENSE.md GPL-2.0
 */

OpenSource.org link

/**
 * @license https://opensource.org/licenses/GPL-2.0 GPL-2.0
 */

GPL-2.0 no link

/**
 * @license GPL-2.0
 */

GPLv2 no link

/**
 * @license GPLv2
 */

Comments

  • Vanilla Forums
    Vanilla Forums
    edited July 2018

    There's also the license declaration in the addon.json file, for which we've standardized on GNU GPLv2 and have encoded it in our community addon directory license check.

    When I last audited this, I used:

    @license http://www.opensource.org/licenses/gpl-2.0.php GNU GPL v2

    which still seems to be reflected as the majority variant. I recall I'd recently read that the GNU foundation was Very Unhappy with folks calling it the "GPL" instead of the "GNU GPL" which is why I used its full name. If the standard is now GPL-2.0 that's fine, but we should update our code check for this (with backwards compatibility).

  • Unknown
    Unknown
    edited July 2018

    Very Unhappy™

    While I'm happy with

    /**
 * @license http://www.opensource.org/licenses/gpl-2.0.php GNU GPL v2
 */
  • Unknown
    Unknown
    edited July 2018

    It should be

    @license https://opensource.org/licenses/GPL-2.0 GPL-2.0

    GPL V2 is not standard. See https://spdx.org/licenses/

  • Unknown
    Unknown

    It looks like the SPDX has deprecated GPL-2.0 so the newest version is:

    @license GPL-2.0-only

    The URL is nice and all, but I'm not personally a fan.

  • Unknown
    Unknown

    I've fixed mine:

    Screen Shot 2018-08-29 at 11.09.35 AM.png


Categories