Clarify how to update recipes

This commit is contained in:
Fabien Potencier
2021-01-18 08:25:55 +01:00
parent 143274cbb1
commit 2b1718a2e7
+16
View File
@@ -47,6 +47,22 @@ options and configurators.
When creating a recipe, don't create bundle config files under
``config/packages/`` when no options are set.
Updating Recipes
----------------
When a recipe needs to be updated, we try to minimize the impact for the
current versions. Creating a new project with a set of dependencies should
always use the same recipes to avoid differences between the generated code and
the existing documentation, blog posts, videos for these versions.
As a rule of thumb, consider the same principles as semantic versioning:
* Only change an existing recipe for a version in case of a bug (typos,
mis-configuration, ...);
* If the change is about a new best practice or a different way of doing
something, do it for the next version of the dependency.
Options
-------