Skip to content

Commit 776eaee

Browse files
committed
Reworded as a definition list
1 parent 4276ced commit 776eaee

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

cookbook/bundles/best_practices.rst

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -388,19 +388,24 @@ Composer Metadata
388388

389389
The ``composer.json`` file should include at least the following metadata:
390390

391-
* ``name``, which includes the vendor and the short bundle name. If you are
392-
releasing the bundle on your own instead of on behalf of a company, use your
393-
personal name (e.g. ``johnsmith/blog-bundle``). The bundle short name excludes
394-
the vendor name and separates each word with an hyphen. For example:
395-
``AcmeBlogBundle`` is transformed into ``blog-bundle`` and ``AcmeSocialConnectBundle``
396-
is transformed into ``social-connect-bundle``;
397-
* ``description``, a brief explanation of the purpose of the bundle;
398-
* ``type``, use the ``symfony-bundle`` value;
399-
* ``license``, ``MIT`` is the preferred license for Symfony bundles, but you
400-
can use any other value.
401-
* ``autoload``, this information is used by Symfony to load the classes of the
402-
bundle. The `PSR-4`_ autoload standard is recommended for modern bundles, but
403-
`PSR-0`_ standard is also supported.
391+
``name``
392+
Consists of the vendor and the short bundle name. If you are releasing the
393+
bundle on your own instead of on behalf of a company, use your personal name
394+
(e.g. ``johnsmith/blog-bundle``). The bundle short name excludes the vendor
395+
name and separates each word with an hyphen. For example: ``AcmeBlogBundle``
396+
is transformed into ``blog-bundle`` and ``AcmeSocialConnectBundle`` is
397+
transformed into ``social-connect-bundle``.
398+
``description``
399+
A brief explanation of the purpose of the bundle.
400+
``type``
401+
Use the ``symfony-bundle`` value.
402+
``license``
403+
``MIT`` is the preferred license for Symfony bundles, but you can use any
404+
other license.
405+
``autoload``
406+
This information is used by Symfony to load the classes of the bundle. The
407+
`PSR-4`_ autoload standard is recommended for modern bundles, but `PSR-0`_
408+
standard is also supported.
404409

405410
In order to make it easier for developers to find your bundle, register it on
406411
`Packagist`_, the official repository for Composer packages.

0 commit comments

Comments
 (0)