[wp-trac] [WordPress Trac] #48579: Should we reconsider the External Libraries mentions on the credits.php page?
WordPress Trac
noreply at wordpress.org
Sat Dec 28 19:27:16 UTC 2019
#48579: Should we reconsider the External Libraries mentions on the credits.php
page?
-------------------------+------------------------------
Reporter: youknowriad | Owner: (none)
Type: enhancement | Status: new
Priority: low | Milestone: Awaiting Review
Component: Help/About | Version:
Severity: normal | Resolution:
Keywords: | Focuses: docs
-------------------------+------------------------------
Comment (by azaozz):
> These days we have over a million npm dependencies.
> ...
> Should we just highlight the big dependencies? How to decide if a
dependency is big enough? Or maybe we can just remove it?
Been thinking about this for a while. Generally there are two types of
dependencies: software used for "building", and software that is
redistributed with WP. When redistributing open source software (afaik) it
is considered best practice to "give credit where credit is due", even if
that's not explicitly mentioned in the license.
Looking at the npm dependencies: most, if not all, are distributed under
the MIT license which requires retainment of the copyright notices (if
any). This is already the case, it happens "automatically" when building.
See:
https://build.trac.wordpress.org/browser/tags/5.3.2/wp-
includes/js/dist/vendor/react.js#L1, \\
https://build.trac.wordpress.org/browser/tags/5.3.2/wp-
includes/js/dist/vendor/lodash.js#L2.
This is also the case for the "non-npm" dependencies:
https://build.trac.wordpress.org/browser/tags/5.3.2/wp-
includes/js/jquery/jquery.js#L1 \\
https://build.trac.wordpress.org/browser/tags/5.3.2/wp-
includes/js/jquery/ui/core.min.js#L1 \\
https://build.trac.wordpress.org/browser/tags/5.3.2/wp-
includes/js/mediaelement/mediaelement.js#L1 \\
https://build.trac.wordpress.org/browser/tags/5.3.2/wp-
includes/js/backbone.js#L1.
As far as I see there are three options:
- Build and maintain a comprehensive list of all software that is
redistributed with WP, and include it in the readme, or perhaps even in an
"acknowledgement.txt" file which can be auto-generated at build time.
- Mention only some of the "base" dependencies in the readme. That would
probably be: jQuery, React, Backbone, TinyMCE, etc. and also some of the
tools used to build WP like Node.js, Grunt, Webpack, etc.
- Consider it "satisfactory" to have the copyright notices in the
corresponding files.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/48579#comment:2>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list