Skip to content
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

Add a Backward Compatibility Section #66

Merged
merged 2 commits into from
Dec 7, 2022
Merged

Add a Backward Compatibility Section #66

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cb4ec2c
Add BCP section
theofidry Dec 7, 2022
a335ad0
Merge remote-tracking branch 'upstream/main' into feature/bc-policy
theofidry Dec 7, 2022
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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,21 @@ $ ./vendor/fidry/cpu-core-counter/bin/execute.php # From the library
```


## Backward Compatibility Promise (BCP)

The policy is for the major part following the same as [Symfony's one][symfony-bc-policy].
Note that the code marked as `@private` or `@internal` are excluded from the BCP.

The following elements are also excluded:

- The `diagnose` and `execute` commands: those are for debugging/inspection purposes only
- `CpuCoreCounter::getDefaultFinders()`: new finders may be added or the order of finders changed at any time


## License

This package is licensed using the MIT License.

Please have a look at [`LICENSE.md`](LICENSE.md).

[symfony-bc-policy]: https://symfony.com/doc/current/contributing/code/bc.html