8000 Updated Bundles Best Practices for Symfony 4 by javiereguiluz · Pull Request #8616 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content
8000

Updated Bundles Best Practices for Symfony 4 #8616

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

Merged
merged 3 commits into from
Nov 16, 2017
Merged

Updated Bundles Best Practices for Symfony 4 #8616

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f00345
Updated Bundles Best Practices for Symfony 4
javiereguiluz Nov 10, 2017
1f433da
Fixed a missing reference
javiereguiluz Nov 10, 2017
9e6d75d
Fixes by reviewers
javiereguiluz Nov 16, 2017
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
Prev Previous commit
Fixes by reviewers
  • Loading branch information
@javiereguiluz
javiereguiluz committed Nov 16, 2017
commit 9e6d75d2f71aae78c02b6b9204d928fdc03425ca
11 changes: 7 additions & 4 deletions bundles/best_practices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,12 @@ the ``Tests/`` directory. Tests should follow the following principles:
Installation
------------

Bundles must define a `Symfony Flex recipe`_ to automate their integration
in Symfony applications. If some initial configuration is needed to execute
the bundle, including some environment variables, provide them in the recipe.
Bundles should set ``"type": "symfony-bundle"`` in their ``composer.json`` file.
With this, :doc:`Symfony Flex </setup/flex>` will be able to automatically
enable your bundle when it's installed.

If your bundle requires any setup (e.g. configuration, new files, changes to
`.gitignore`, etc), then you should create a `Symfony Flex recipe`_.

Documentation
-------------
Expand Down Expand Up @@ -260,7 +263,7 @@ following standardized instructions in your ``README.md`` file.

Open a command console, enter your project directory and execute:

.. code-block:: terminal
.. code-block:: bash

$ composer require <package-name>

Expand Down
0