Skip to content

Commit 02a5ebd

Browse files
authored
Merge pull request #876 from symfony/recipe-updates
Clarify how to update recipes
2 parents 143274c + 2b1718a commit 02a5ebd

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,22 @@ options and configurators.
4747
When creating a recipe, don't create bundle config files under
4848
``config/packages/`` when no options are set.
4949

50+
Updating Recipes
51+
----------------
52+
53+
When a recipe needs to be updated, we try to minimize the impact for the
54+
current versions. Creating a new project with a set of dependencies should
55+
always use the same recipes to avoid differences between the generated code and
56+
the existing documentation, blog posts, videos for these versions.
57+
58+
As a rule of thumb, consider the same principles as semantic versioning:
59+
60+
* Only change an existing recipe for a version in case of a bug (typos,
61+
mis-configuration, ...);
62+
63+
* If the change is about a new best practice or a different way of doing
64+
something, do it for the next version of the dependency.
65+
5066
Options
5167
-------
5268

0 commit comments

Comments
 (0)