Skip to content

Commit c544f05

Browse files
committed
minor #5620 Changed the recommendation about the LICENSE file for third-party bundles (javiereguiluz)
This PR was squashed before being merged into the 2.3 branch (closes #5620). Discussion ---------- Changed the recommendation about the LICENSE file for third-party bundles | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | all | Fixed tickets | #5599 Commits ------- 80c67b0 Changed the recommendation about the LICENSE file for third-party bundles
2 parents 55726a1 + 80c67b0 commit c544f05

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

cookbook/bundles/best_practices.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,8 @@ The basic directory structure of an AcmeBlogBundle must read as follows:
8383
├─ AcmeBlogBundle.php
8484
├─ Controller/
8585
├─ README.md
86+
├─ LICENSE
8687
├─ Resources/
87-
│ ├─ meta/
88-
│ │ └─ LICENSE
8988
│ ├─ config/
9089
│ ├─ doc/
9190
│ │ └─ index.rst
@@ -102,9 +101,8 @@ that automated tools can rely on:
102101
* ``README.md``: This file contains the basic description of the bundle and it
103102
usually shows some basic examples and links to its full documentation (it
104103
can use any of the markup formats supported by GitHub, such as ``README.rst``);
105-
* ``Resources/meta/LICENSE``: The full license for the code. The license file
106-
can also be stored in the bundle's root directory to follow the generic
107-
conventions about packages;
104+
* ``LICENSE``: The full contents of the license used by the code. Most third-party
105+
bundles are published under the MIT license, but you can `choose any license`_;
108106
* ``Resources/doc/index.rst``: The root file for the Bundle documentation.
109107

110108
The depth of sub-directories should be kept to the minimum for most used
@@ -424,3 +422,4 @@ Learn more from the Cookbook
424422
.. _`PSR-4`: http://www.php-fig.org/psr/psr-4/
425423
.. _`Semantic Versioning Standard`: http://semver.org/
426424
.. _`Packagist`: https://packagist.org/
425+
.. _`choose any license`: http://choosealicense.com/

0 commit comments

Comments
 (0)