mirror of
https://github.com/symfony/recipes-contrib.git
synced 2026-09-11 15:16:55 +03:00
Roméo RAZAFINDRAKOTOandGitHub
163cad75a7
* Add Glide bundle configuration files Added a manifest.json and a dahromy_glide.yaml to configure the Glide bundle in Symfony. The manifest.json includes the bundle and its environment-specific parameters, while the dahromy_glide.yaml sets up source, cache locations and the glide signature key. * # This is the 1st commit message: Add 'gd' driver to dahromy_glide configuration The gd library driver has been added to the dahromy_glide.yaml configuration file. This change enables image processing capabilities provided by the gd library in the dahromy/glide-symfony project. # This is the commit message #2: Add base_url to glide configuration In the dahromy_glide.yaml configuration file, a new line specifying the base_url for image storage has been added. This amendment allows the glide library to know where to store and retrieve images. # This is the commit message #3: Add newline at the end of glide.yaml file A newline has been added at the end of the dahromy_glide.yaml file. This is in accordance with standard coding practices and helps to prevent any potential parsing errors due to the absence of a newline. # This is the commit message #4: Remove 'gd' driver and base_url from glide config The 'gd' driver and the 'base_url' configuration option have been removed from the Glide configuration. Other default configuration options can be added as needed. This change simplifies the default configuration. # This is the commit message #5: Move manifest and config files to 1.0 directory All manifest and config files have been moved to a newly created 1.0 directory. This change is to improve file organization and version control. The structure change does not bring any functionality differences. # This is the commit message #6: Add PHP version conflict in manifest.json The update adds a "conflict" field to the manifest.json which restricts the usage of the package with PHP versions less than 8.0. This ensures that the application is run on the supported PHP versions, preventing any compatibility issues. # This is the commit message #7: Add new project files and update configuration This commit introduces new .idea project files and updates DahRomy Glide Bundle routes and configuration. The various .idea files correspond to Project Modules, Git Toolbox settings and PHP options. Additionally, the Glide configuration has been altered to change the source directory and the signature key has been removed. Add new project files and update configuration This commit introduces new .idea project files and updates DahRomy Glide Bundle routes and configuration. The various .idea files correspond to Project Modules, Git Toolbox settings and PHP options. Additionally, the Glide configuration has been altered to change the source directory and the signature key has been removed. Add newline at end of YAML files and clean up .idea - Add newline at end of YAML configuration files - Remove .idea directory - Add .idea to .gitignore Add newline at end of YAML configuration files Two YAML configuration files in the glide-symfony project lacked a newline character at the end of the file. These have been added to the `glide.yaml` file in both the routes and packages directories, following the POSIX standards for text files. Remove .idea directory Add .idea to .gitignore Remove .gitignore
Symfony Recipes (Contrib)
=========================
Symfony recipes allow the automation of Composer packages configuration via the
`Symfony Flex`_ Composer plugin.
This repository hosts contributed recipes for Composer packages that are not
part of the "official" `Symfony recipes`_. To enable recipes defined in this
repository for your project, run the following command:
.. code-block:: bash
composer config extra.symfony.allow-contrib true
See `RECIPES.md`_ for a full list of recipes that live in this repository.
Contributing
------------
For more information about contributing a recipe, read the `documentation`_ on
the main repository and the Best Practices below.
Unlike for official recipes, the pull requests for new contrib recipes are
managed by the community. Pull requests are reviewed by the Symfony Bot and
automatically merged when the following conditions are met (in that order):
* The pull request title does not contain "WIP";
* The Symfony Bot approved the pull request and reported no validation errors;
* Someone (not the Symfony bot nor the pull request author) approved the pull
request;
* The pull request author or the reviewer is a Symfony Core Merger.
Best Practices
--------------
Default Bundle Config
#####################
A recipe for a bundle should not contain all the configuration the bundle has to
offer. A good recipe only contains a suggestion config for an application. That
is config that needs to be configured but no real default value exists.
**Example:** The "items per page" in a paginator bundle or API credentials for an API
client bundle.
If environment variables are used, they must be provided to the bundle's config.
A bundle without config or routes do not need a recipe. Flex is smart enough to
install that bundle anyways.
Modify Other Bundle's config
############################
The general rule is that no recipe should modify other bundle's configuration. There
is however one exception. A recipe is allowed to append to a "config collection".
**Example:** Add a new connection to DoctrineBundle or add a new cache adapter to Symfony
Framework bundle.
Maintainability
###############
The symfony/recipes-contrib repository should contain the config for packages. Using
"``copy-from-package`` Configurator" for routes and config is not allowed. That would
make the recipes impossible to maintain and to assure their quality.
Recipes is also not a replacement for ``composer create-project``. That means it is
not intended to be used as "bootstrap full application" and copy a lot of PHP code,
front-end assets etc. Recipes are for quick installation of packages.
.. _`Symfony Flex`: https://github.com/symfony/flex
.. _`Symfony recipes`: https://github.com/symfony/recipes
.. _`documentation`: https://github.com/symfony/recipes
.. _`RECIPES.md`: https://github.com/symfony/recipes-contrib/blob/flex/main/RECIPES.md