Skip to content

Clarify how to update recipes #876

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.

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 1 commit into from
Jan 18, 2021
Merged
Changes from all commits
Commits
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
16 changes: 16 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------

Expand Down