Page MenuHomePhabricator

Update dev guidelines re license
Closed, ResolvedPublic

Description

Clarify the motivation for the current license choice and add a section around the practicalities of it. See notes

Related Objects

Event Timeline

Lokal_Profil renamed this task from Update dev guidelines re-license to Update dev guidelines re license.Oct 4 2019, 5:52 AM
Lokal_Profil created this task.

SHould also include a note about GPL 2-or-later for MediaWiki for compatibility

Perhaps being super clear with an example of PHP file comment rather than just a reference to the @license tag, so that people don't use class level comments (as I did).

* For php: Add the following to a comment in the top of each file. <code>@license <license></code>

vs

* For php: Add a file-level PHPDoc comment with license tag in the top of each file, above the use-statement and below any potential namespace-statement. <code>
<?php

namespace Foo

/** 
  * @file
  * @license <license>
 */

use \Bar;
</code>

Or something along that path.

How about the phrasing below?
* For php: Add a PHPDoc <code>@license <license></code> comment to the top of each file, above the use-statement and below any potential namespace-statement.<ref>See e.g. [https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/Wikispeech/+/d9cf68ea3e5e02104ad0c70f4beec1578b67718b/includes/SpeechoidConnector.php|this example file].</ref>

How about the phrasing below?
* For php: Add a PHPDoc <code>@license <license></code> comment to the top of each file, above the use-statement and below any potential namespace-statement.<ref>See e.g. [https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/Wikispeech/+/d9cf68ea3e5e02104ad0c70f4beec1578b67718b/includes/SpeechoidConnector.php|this example file].</ref>

added