From 50fcda260aadbb221fc52f1160d7845d2041af40 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Fri, 26 Aug 2022 13:10:48 +0200 Subject: [PATCH 1/2] Improve documentation about contributing --- docs/en/reference/index.rst | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/en/reference/index.rst b/docs/en/reference/index.rst index b09d2824..01400f6c 100644 --- a/docs/en/reference/index.rst +++ b/docs/en/reference/index.rst @@ -123,6 +123,13 @@ Versioning This library follows semantic versioning, and additions to the code ruleset are only performed in major releases. +The patch branch can receive internal changes, such as CI pipeline +improvements, test workflow improvements, and can receive bugfixes. For +instance, such as removing rules that were not meant to be added. + +The minor branch can receive refactorings, and dependency updates that +do not affect the code ruleset. + Testing ======= @@ -136,13 +143,21 @@ need to execute the ``test`` GNU make target: Sometimes you are enabling a sniff that enforces some features for a specific PHP version, that will probably cause our build pipeline to fail when running on such versions. -We have created the ``update-compatibility-patch`` GNU make target to help you with that: +We have created the ``update-compatibility-patch-*`` GNU make targets to +help you with that. For instance, for PHP 6.0, you would run .. code-block:: bash - $ make update-compatibility-patch + $ make update-compatibility-patch-60 + +That target will attempt to apply the latest version of our +compatibility patch for that version of PHP and ask you to adjust the +code in ``tests/fixed`` and ``tests/expected_report.txt`` using the +editor of your preference. + +If the patch does not apply cleanly, you can edit it to edit or remove +hunks that relate to files you changed in your PR. -That target will apply the latest version of our compatibility patch and ask you to adjust the code in ``tests/fixed`` and -``tests/expected_report.txt`` using the editor of your preference. -Once you are done, please type "y" to resume the command, which will update the compatibility patch and create a commit -with your changes for you to push to your remote branch. +Once you are done, please type "y" to resume the command, which will +update the compatibility patch and create a commit with your changes for +you to push to your remote branch. From d6906253ce7a538d8f1cc39c2c2cdc49cd15aa24 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9goire=20Paris?= Date: Fri, 26 Aug 2022 14:10:48 +0200 Subject: [PATCH 2/2] Regroup versioning and testing and link to it People will be more likely to read this guide. --- CONTRIBUTING.md | 3 +++ docs/en/reference/index.rst | 7 +++++-- 2 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..55eaba12 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing + +See https://www.doctrine-project.org/projects/doctrine-coding-standard/en/stable/reference/index.html#contributing diff --git a/docs/en/reference/index.rst b/docs/en/reference/index.rst index 01400f6c..7a01910f 100644 --- a/docs/en/reference/index.rst +++ b/docs/en/reference/index.rst @@ -117,8 +117,11 @@ and `the list of configuration options