From e2350822b1900dcc67b10ebee1dbf1027649f331 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 11 Aug 2015 17:32:10 +0200 Subject: [PATCH 1/2] Changed the recommendation about the LICENSE file for third-party bundles --- cookbook/bundles/best_practices.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/cookbook/bundles/best_practices.rst b/cookbook/bundles/best_practices.rst index 58f01c74366..2c3bcd47277 100644 --- a/cookbook/bundles/best_practices.rst +++ b/cookbook/bundles/best_practices.rst @@ -83,9 +83,8 @@ The basic directory structure of an AcmeBlogBundle must read as follows: ├─ AcmeBlogBundle.php ├─ Controller/ ├─ README.md + ├─ LICENSE ├─ Resources/ - │ ├─ meta/ - │ │ └─ LICENSE │ ├─ config/ │ ├─ doc/ │ │ └─ index.rst @@ -102,9 +101,8 @@ that automated tools can rely on: * ``README.md``: This file contains the basic description of the bundle and it usually shows some basic examples and links to its full documentation (it can use any of the markup formats supported by GitHub, such as ``README.rst``); -* ``Resources/meta/LICENSE``: The full license for the code. The license file - can also be stored in the bundle's root directory to follow the generic - conventions about packages; +* ``LICENSE``: The full license for the code. This license file can also be stored + in the bundle's ``Resources/meta/`` directory for backwards compatibility reasons; * ``Resources/doc/index.rst``: The root file for the Bundle documentation. The depth of sub-directories should be kept to the minimum for most used From 79bed3844fef4b9134fc74880079310ed73e65ac Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 18 Aug 2015 08:34:28 +0200 Subject: [PATCH 2/2] Reworded the desription about the used license --- cookbook/bundles/best_practices.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/cookbook/bundles/best_practices.rst b/cookbook/bundles/best_practices.rst index 2c3bcd47277..cd15f03eb7e 100644 --- a/cookbook/bundles/best_practices.rst +++ b/cookbook/bundles/best_practices.rst @@ -101,8 +101,8 @@ that automated tools can rely on: * ``README.md``: This file contains the basic description of the bundle and it usually shows some basic examples and links to its full documentation (it can use any of the markup formats supported by GitHub, such as ``README.rst``); -* ``LICENSE``: The full license for the code. This license file can also be stored - in the bundle's ``Resources/meta/`` directory for backwards compatibility reasons; +* ``LICENSE``: The full contents of the license used by the code. Most third-party + bundles are published under the MIT license, but you can `choose any license`_; * ``Resources/doc/index.rst``: The root file for the Bundle documentation. The depth of sub-directories should be kept to the minimum for most used @@ -422,3 +422,4 @@ Learn more from the Cookbook .. _`PSR-4`: http://www.php-fig.org/psr/psr-4/ .. _`Semantic Versioning Standard`: http://semver.org/ .. _`Packagist`: https://packagist.org/ +.. _`choose any license`: http://choosealicense.com/