Updated Bundles Best Practices for Symfony 4 #8616
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wouterj
requested changes
Nov 12, 2017
bundles/best_practices.rst
Outdated
| Installation | ||
| ------------ | ||
|
|
||
| Bundles must define a `Symfony Flex recipe`_ to automate their integration |
There was a problem hiding this comment.
This seems way to strict and unwanted in my opinion. You only need to add a flex recipe if you need logic to be executed when installing your bundle. Otherwise, type: symfony-bundle is enough to have auto registration.
We shouldn't want to have many empty manifests in the contrib repository.
There was a problem hiding this comment.
I agree. How about:
Bundles should set ``"type": "symfony-bundle"`` in their ``composer.json`` file. With this,
`Symfony 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 `Flex recipe`_.
bundles/best_practices.rst
Outdated
|
|
||
| Open a command console, enter your project directory and execute: | ||
|
|
||
| .. code-block:: terminal |
There was a problem hiding this comment.
We have to use bash here, as terminal is a special Symfony docs only lexer.
weaverryan
requested changes
Nov 16, 2017
bundles/best_practices.rst
Outdated
| Installation | ||
| ------------ | ||
|
|
||
| Bundles must define a `Symfony Flex recipe`_ to automate their integration |
There was a problem hiding this comment.
I agree. How about:
Bundles should set ``"type": "symfony-bundle"`` in their ``composer.json`` file. With this,
`Symfony 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 `Flex recipe`_.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.