From cb4ec2c8d6d8b8cb962a91fea85960462a698e8f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9o=20FIDRY?= Date: Thu, 8 Dec 2022 00:29:28 +0100 Subject: [PATCH] Add BCP section --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 4082beb..d31da8e 100644 --- a/README.md +++ b/README.md @@ -53,8 +53,21 @@ $cores = (new CpuCoreCounter($finders))->getCount(); ``` +## 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