Skip to content

Commit

Permalink
Add BCP section (#66)
Browse files Browse the repository at this point in the history
Closes #59
  • Loading branch information
theofidry authored Dec 7, 2022
1 parent 2594740 commit 1bd4c79
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
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

0 comments on commit 1bd4c79

Please sign in to comment.