Skip to content

Update best_practices.rst #10559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update best_practices.rst #10559

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion bundles/best_practices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,9 @@ The ``composer.json`` file should include at least the following metadata:

``autoload``
This information is used by Symfony to load the classes of the bundle. It's
recommended to use the `PSR-4`_ autoload standard.
recommended to use the `PSR-4`_ autoload standard. Use the namespace as key,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It'd suggest a colon instead of a dot: standard: use

and the location of the bundle's main class (relative to ``composer.json``)
as value, example: ``"autoload": { "psr-4": { "JohnSmith\\BlogBundle\\": "" } }``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding src/ in the example would be even more descriptive (and is common practice):
"autoload": { "psr-4": { "JohnSmith\\BlogBundle\\": "src/" } }


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