Skip to content

Added a BC note #77

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Added a BC note #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,13 @@ Please see the [official documentation](http://php-http.readthedocs.org/en/lates
$ composer test
```

## Backwards compatibility promise

The backwards compatibility promise does not include classes marked with the `@internal` annotation. Nor does it
include the default order of which the strategies are executed. However we do promise that we do not remove any strategies
and we will also not remove any classes in the `CommonClassesStrategy`. We do also promise to support the following Puli versions:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rather say "we promise to support/not remove the following classes: [list]".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to make a list because it will be harder to maintain (especially if we move this to the documentation repo). But the formulation could be improved.


* 1.0.0-beta10

## Contributing

Expand Down