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.

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

wants to merge 1 commit into from

Conversation

Nyholm
Copy link
Member

@Nyholm Nyholm commented Jul 16, 2016

It should be more clear what our BC is. With this BC promise we can.

  • Change the order of our strategies and add strategies in any order
  • Change the order/priority of classes in CommonClassesStrategy

The consequence is that you can never be sure what client that is going to be found but you can be sure that updating a minor version will not result in that a client is not found any more.

Related to #48


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.

@sagikazarmark
Copy link
Member

Shouldn't we rather place this in the documentation?

@Nyholm
Copy link
Member Author

Nyholm commented Jul 16, 2016

Maybe it should be placed in the documentation repo. I just figured, if you are about to update versions you are most probable to go to packagist, github and then to our documentation page.

In one way it makes sense to have the BC promise close to the changelog and upgrade docs. But it do also make a lot of sense to have the BC promise next to all our other documentation.

Maybe we should create a full page in the docs about our general BC promise and all our special ones (like this and possible also for HTTPlugBundle).

@sagikazarmark
Copy link
Member

Sounds like a good idea to me.

Tobias Nyholm notifications@github.com ezt írta (2016. július 16.,
szombat):

Maybe it should be placed in the documentation repo. I just figured, if
you are about to update versions you are most probable to go to packagist,
github and then to our documentation page.

In one way it makes sense to have the BC promise close to the changelog
and upgrade docs. But it do also make a lot of sense to have the BC promise
next to all our other documentation.

Maybe we should create a full page in the docs about our general BC
promise and all our special ones (like this and possible also for
HTTPlugBundle).


You are receiving this because you commented.
Reply to this email directly, view it on GitHub
#77 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/ABK2kOVM48aEkHJoYikCgHd8T5dMYZ3uks5qWLBbgaJpZM4JN-0s
.

@Nyholm Nyholm closed this Jul 16, 2016
@Nyholm Nyholm deleted the dev-bc branch July 16, 2016 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants